WebObjects with Scala

=== What is Scala? ===

[[Scala>>http://en.wikipedia.org/wiki/Scala_(programming_language)]] is a modern, multi-paradigm JVM language that is most often compared to [[Groovy>>http://en.wikipedia.org/wiki/Groovy_(programming_language)]], [[Clojure>>http://en.wikipedia.org/wiki/Clojure]] or [[Erlang>>http://en.wikipedia.org/wiki/Erlang_(programming_language)]]. Its [[functional language>>http://en.wikipedia.org/wiki/Functional_programming]] foundations and built-in Actors library makes it especially attractive for concurrent computing. In this day and age of multi-core processors concurrent computing can not be ignored.

4

5

Many of Scala's features have been designed with concurrency in mind, some of which may not be unfamiliar to Objective-C or WebObjects developers. Here's a summary:

6

7

|= |= Objective-C |= Java |= Scala

8

|= Immutability | Collections //e.g: NSArray/NSMutableArray// | No | Yes

9

|= Closures | Blocks (//Extension//) | No | Anonymous Functions

10

|= Static variables | Yes | Yes | No

11

|= Static methods or functions | Yes | Yes | No

12

|= Concurrency | [[Grand Central Dispatch>>http://en.wikipedia.org/wiki/Grand_Central_Dispatch]] (//Extension//) | //Threads// | [[Actors>>http://en.wikipedia.org/wiki/Actor_model]]

13

|= |= Weakly Typed |= --Strongly Typed-- |= Strongly Typed

14

15

Other notable features include:

16

17

|= |= Objective-C |= Java |= Scala

18

|= Parametered methods | Yes //e.g: addObject: to~:// | No | Yes //e.g: add(object= ,to=)//

19

|= Class composition | Categories | Interfaces | Traits

20

21

=== Why Use Scala? ===

22

23

For WebObjects developers, Scala offers itself as a powerful, safe and easy-to-use solution for [[concurrent computing>>Building Concurrent Applications with WebObjects and Scala]]. (In other words, Scala Actors can be used for problems that would have normally required threads).

24

25

=== Can WebObjects be Programmed In Scala? ===

26

27

Yes. It is very simple.

28

Scala compiles to java bytecode.

29

30

Furthermore, being a multi-paradigm language grants Scala easy WebObjects-interoperability.

===== Caveats =====

Legacy tool support is often cited as a weak point. If your Application class is in Scala then you will have to create an Eclipse launch configuration manually. Also the [[Scala plugin>>http://www.scala-ide.org]] can be slow at times and sometimes buggy.

35

36

= WebObjects In Scala =

37

38

The following highlights some of the differences between Java and Scala in WebObjects:

== EOs in Scala ==

=== Thread-Safe Shared Vars ===

43

44

Scala doesn't have static variables or methods. Instead Scala employs the [[Singleton Pattern>>http://en.wikipedia.org/wiki/Singleton_pattern]] which is built into the language and is **thread-safe**: a class can have a //Companion Object// that will allow you to achieve something equivalent to static variables - but better.

45

46

You don't have to worry about synchronizing access to shared mutable fields in a concurrent application.

47

This is not however true for mutable ##val## e.g: ##NSMutableArray##, ##scala.collection.mutable.ListBuffer## which you will have to synchronize the adding to or removing from.

48

49

The following is an example of the use of a //Companion Object// for Talent in Scala instead of Talent static fields in Java.

Java:

public class _Talent extends EOGenericRecord {

56

public static final String ENTITY_NAME = "Talent";

Scala:

object Talent extends EOGenericRecord {

65

val ENTITY_NAME = "Talent"

This value will be accessed exactly the same way in both languages:

Talent.ENTITY_NAME

==== Compacted imports ====

78

79

Two lines in Java are compacted into one in Scala.

In Java:

import com.webobjects.eocontrol.EOGenericRecord;

86

import com.webobjects.eocontrol.EORelationshipManipulation;

In Scala:

import com.webobjects.eocontrol.{EOGenericRecord, EORelationshipManipulation}

== WOComponents in Scala ==

99

100

==== Compact Constructors ====

101

102

Scala allows for simpler use of multi-valued constructors than Java.

In Java:

public class MenuHeader extends WOComponent {

109

110

public MenuHeader(WOContext aContext) {

super(aContext);

}

In Scala:

class MenuHeader(context: WOContext) extends WOComponent(context: WOContext) {

==== Simplified Exception Handling ====

125

126

Scala doesn't force you to catch exceptions unlike in Java.

127

In addition, the syntax employs Scala's very powerful **pattern matching** to handle exceptions.

In Java:

try {

EditPageInterface epi = D2W.factory().editPageForNewObjectWithEntityNamed(_manipulatedEntityName, session());

135

epi.setNextPage(context().page());

136

nextPage = (WOComponent) epi;

137

} catch (IllegalArgumentException e) {

138

ErrorPageInterface epf = D2W.factory().errorPage(session());

139

epf.setMessage(e.toString());

140

epf.setNextPage(context().page());

141

nextPage = (WOComponent) epf;

}

In Scala:

try {

var epi: EditPageInterface = D2W.factory.editPageForNewObjectWithEntityNamed(_manipulatedEntityName, session)

152

epi.setNextPage(context.page)

153

nextPage = epi.asInstanceOf[WOComponent]

154

} catch {

155

case e: IllegalArgumentException => {

156

var epf: ErrorPageInterface = D2W.factory.errorPage(session)

157

epf.setMessage(e.toString)

158

epf.setNextPage(context.page)

159

nextPage = epf.asInstanceOf[WOComponent]

}

}

==== Scala Annotations vs. Generated Accessors ====

166

167

An example of accessing variables in WebObjects with the following languages:

168

169

|= |= Objective-C |= Java |= Scala

170

|= getter | ##object name## | ##object.name()## | ##object.name##

171

|= setter | ##object setName:aName## | ##object.setName(aName)## | ##object.name = aName##

172

173

Of course in Java, we may generate WebObjects classes with "get" methods as well in order to stick to convention.

174

In scala there is an additional convenience we may use to produce "get" and "set" methods in addition to the default Scala accessors - Scala Annotations.

175

176

E.g, in Main.scala we annotate our component keys with ##@BeanProperty## to automatically create public "set" and "get" methods.

177

These variables can then be accessed via //KVC//.

import scala.reflect.BeanProperty

182

183

@BeanProperty var username = new String()

184

@BeanProperty var password = new String()

185

@BeanProperty var isAssistantCheckboxVisible = false

== How to Use Scala Collections with EOF ==

190

191

To use the Scala Collections API with an NSArray or NSDictionary you simply need to add an import:

import scala.collection.JavaConversions._

After that, you may access the typical Scala collection methods directly on NSArray.  This employs a feature of Scala known as implicit conversions to automagically cast a NSArray (a Java Iterable) into a Scala Iterable while leaving the actual object unchanged.  Alternatively, you could generate an actual new scala.List instance by calling myNSArray.toList.

200

201

== How to Add Scala to a WO Project ==

This is for Eclipse/WOLips IDE

== WO Scala Example ==

212

213

The following example is an almost 100% Scala WO app. In reality it is a mixed Java/Scala app:

214

All the EO logic and WO components are in Scala.

215

Only the Application class remains Java.

216

217

It is based on the D2W Movies example.

=== Setup ===

1. [[Install the Scala eclipse IDE>>http://www.scala-ide.org/]]

224

1. Right-click on Application.java and run as a WOApplication (as usual).

225

226

Application can be made into a Scala class as well, but then you will have to create a launcher in Eclipse manually.

== EO Templates ==

When you create your ##.eogen## file, be sure to make the following changes in the EOGenerator Editor:

231

232

1. Point to the local [[Scala versions>>http://wiki.objectstyle.org/confluence/display/WOL/EOGenerator+Templates+and+Additions]] of the .eotemplate files for ##Entity## and ##Entity##

233

1. Change the File Names Extension to "scala"

234

1. In Destination Paths set the Superclass Package (e.g: base)

235

1. Uncheck Java under Options

236

237

== How to Build & Deploy a WebObjects Scala Project with Ant ==

238

239

1. [[Download>>http://www.scala-lang.org/downloads]] and install Scala