Velocity EOGenerator (Veogen)

1

This is a basic guide to getting the Velocity Generator to work under Leopard, using Eclipse 3.3.1.1 and WOLips 3.3.4669, later versions should work. The guide is basic in that it should work the way it's detailed below, it doesn't represent the only way, nor probably an optimized way to work with Velocity Generator.

2

3

See also [[EOGenerator Templates & Additions>>EOGenerator Templates and Additions]] for detailed information on template contents.

4

5

=== History and Context ===

6

7

(from Pierce T Wetter III)

8

EOModeler had built in code generation, which always sucked, because it didn't use the [[Generation Gap Pattern>>http://www.research.ibm.com/designpatterns/pubs/gg.html]]. It used some kind of Apple-specific template format.

9

10

[[EOGenerator>>http://www.rubicode.com/Software/EOGenerator/]], written in objc, relied on an objc-EOF framework to parse the model. That's broken in Mac OS 10.5, (WO 5.4), even if you have the 5.3 frameworks installed, because the Java-objc bridge it uses is not available on 10.5. It uses MiscMerge templates, an open source objc library.

11

12

[[JavaEOGenerator>>http://developer.apple.com/samplecode/JavaEOGenerator/]] is an Apple replacement that uses WO style templates (.html, .wod, etc.), which means it's actually written as a .woa. It uses the WO code to parse the model. The advantage of it is that if Apple changes the model file format, presumably they might change JavaEOGenerator. The disadvantage is that you have to rewrite your templates anyways.

13

14

What people are calling VelocityGenerator is built into WOLips, and uses the code from EntityModeler inside WOLips to parse the model. Given that Apple is funding EntityModeler these days, presumably it will be inherently compatible with any/all .eomodel files going forward. It uses a template library in [[Velocity format>>http://velocity.apache.org/engine/releases/velocity-1.5/vtl-reference-guide.html]], [[Velocity>>http://velocity.apache.org/]] being an open source Java library. It's main advantage is that it's built into WOLips, so there's nothing else to install, and it has some useful built-in defaults (like looking in a templates folder for the templates).

15

16

My decision: After considering the above, I went with the Velocity templates. They were built in, the .eogen default was to use that anyways, so I'll have zero-config issues with the other team members, and Mike Shrag's public much-more-capable template examples were in that format anyways.

=== Tutorial ===

There are two ways: create eclipse-wide settings, or create settings per project.

21

22

Note: There is actually no need to download Mike's templates as described below unless you want to customize them. WOLips includes two sets of default templates in the .jar files (so don't bother searching your file system for them) - one as described below and another for use with WOnder. If you are using WOnder, you need to follow Mike's instructions for their use: "Where it says "Entity.java" and "//Entity.java" you can use WonderEntity.java and WonderEntity.java ... If your individual .eogen files override that, you will have to set it in there also". If you leave the "EOGenerator Template Folder" field empty, it will use the default templates...//

23

24

==== eclipse-wide settings for EOGeneration ====

25

26

~1. Download the templates that Mike Schrag made from [[http://webobjects.mdimension.com/wolips/EOGenerator/Velocity%20EOGenerator%20Templates/]]

27

28

and place them in a folder. In my case that was in

29

30

/Applications/Developing/VelocityEOGeneratorTemplates

31

32

Inside this folder you will have two standard templates: Entity.java en Entity.java. Do not change them for the moment.

33

34

(Additional templates and a reference are available [[here>>EOGenerator Templates and Additions]])

35

36

2. Go to Preferences > WOLips > EOGenerator

37

38

In EOGenerator Template Folder, fill in the folder you have placed the templates

39

In EOGenerator Java Template fill in Entity.java

40

In EOGenerator Subclass Java Template fill in Entity.java

41

42

This is how it looks in my settings:

\\ !VEOGeneratorSettingsEclipse.png|align=center!\\

\\

\\

\\

3. Go to the eomodel from which you want to create classes and subclasses in the WOPackage sidebar of Eclipse

54

55

4. Right click and choose WOLips Tools > Create EOGenerator File from the contextual menu, (it's a submenu)

\\ !CreateEOGenContextualMenu.png|align=center!\\

\\

\\

\\

Now a eogen file is created which has the name of the EOModel and an .eogen extension.

67

If there is already an eogen file, then another one will be created, with a number between the EOModel name and the extension.

68

The one with the highest number will be the newest (unless you decided to throw earlier ones away, then the numbering starts all over again).

\\ !MoreEogenfiles.png|align=center!\\

\\

\\

\\

5. Go to the eogen file, right click and choose EOGenerate... from the contextual menu.

\\ !EOGenerateContextualMenu.png|align=center!\\

\\

\\

\\

If you have some definitions in your EOModel that have a Class Name that is not an EOGenericRecord, then the appropriate java class and subclass will be generated.

91

92

For instance: a Person class name in EOModel will result in a Person.java file (which will be overwritten the next time EOGeneration will take place) and a Person.java file. The java file without the underscore is the file that will not be overwritten the next time. This file is the file that you would add your own methods. The next time the model changes, the underscore.java file will be overwritten, but your methods are safe.

93

94

6. Check if everything worked out fine. If not (e.g. you made a typing error and a java file happens to be empty) throw away the generated file yo do not want, and restart the process.

95

96

7. If you are fine, you can start fine tuning your templates, or start defining templates per project.

97

98

==== making Velocity EOGenerator settings per project ====

99

100

~1. Under Preferences > WOLips > EOGenerator

101

~> Remove all entries (this is not strictly necessary, but it rules out any errors at the project level)

\\ !1. EOGenerator Project.png|align=center!\\

\\

\\

\\

2. Add a folder named templates in your project folder, inside of which you place your template files.

113

For starters, don't rename them. You can download them here:

114

[[http://webobjects.mdimension.com/wolips/EOGenerator/Velocity%20EOGenerator%20Templates/]]

\\ !2. Directory Structure.png|align=center!\\

\\

\\

\\

Other options for Veogen to pick up any changes you wish to make to the templates:

126

127

* inside your eogen file you need to set template path to the folder containing Entity.java, and if it's named something other than Entity.java, you need to also set template name. Note that template name is ONLY a name, not a full path.

128

* or locate the template files in one of the paths that Velocity EOGenerator looks in by default (,,/Library/Application Support/WOLips/EOGenerator///Entity.java, for example).//,,

129

130

3. Double check your model. It used to be true that none of your entities could extend EOGenericRecord. That is no longer true and you can use either custom classes or EOGenericRecord as a class, or a mix of the two. We suggest that your entity classes should be in packages for this all to work optimally, such as "your//com.projectname.eo//class". If you use a class that is not in a package, there may be a number of errors in the resulting Java class files.

\\ !3. Entities Snapshot.png|align=center!\\

\\

\\

\\

4. Create or edit your .eogen file, mine looks like this:

\\ !4. Config Overview.png|align=center!\\

\\

\\

\\

5. Double check, and open the .eogen file using open with > text editor. The whole command must all be on a single line; this is formatted for clarity:

{code}

1. -destination Sources

158

-java

159

-javaTemplate _Entity.java

160

-model Resources/SF.eomodeld

161

-packagedirs

162

-subclassDestination Sources

163

-subclassJavaTemplate Entity.java

164

-templatedir templates

-verbose

{code}

6. If you are not seeing your entity files that start with the underscore character "//" in Eclipse, it is because you have them filtered out. Select filters from the down triangle in the package explorer~://

\\ !select.png|align=center!\\

\\

\\

\\