Programming__WebObjects-EOF-Using EOF-EOGenerator

== Overview ==

If you've ever used EOModeler's Java source code generator, you know how much of a pain it can be when you make changes to your model objects and have to merge changes in later. One solution for this is to use [[EOGenerator>>http://www.rubicode.com/Software/EOGenerator/]], an application developed by Rubicode Software, which uses the Generation Gap pattern to create your Java files from your EOModels. EOGenerator produces TWO java files for each Entity rather than one. Take the example of a Person entity. The first java file is //Person.java, which contains all of the autogenerated methods. The second java file is Person.java, and Person extends //Person. The second file is where you place all of your customizations. Any time your model changes, only your //Xxx.java files are updated, and your customizations are left untouched. Additionally, EOGenerator allows for the creation of extensive custom templates for your files, which provides the ability to place convenience methods in your //Xxx.java files.

4

5

== Advantages ==

6

7

There are several advantages to using EOGenerator over EOModeler's default Java file generation and merging with FileMerge.

8

9

* EOGenerator uses the Generation Gap pattern, which provides a much cleaner separation of autogenerated vs customized code with no need to deal with merging at all. There are border cases with FileMerge that can cause you to deal with annoying conflicts.

10

* EOGenerator uses the MiscMerge language for its templates. This allows you to extend the core templates with extensive customizations (see the EOGenerator Mods section below), better supporting your own custom development process and workflow.

11

* As David LaBer put it, "all the cool kids use it - and we all know looking cool is the **most** important criteria".

== How To Use It ==

Kieran Kelleher has writtten an [[Introduction to EOGenerator>>http://homepage.mac.com/kelleherk/iblog/C1837526061/E1908382110/index.html]] on his blog.

16

17

It's actually very simple to use. The quick start is:

18

19

* Download and untar EOGenerator from the Rubicode site

20

* Run the following command:

eogenerator -model /path/to/model/YourModel.eomodeld -destination /path/to/source/folder -subclassDestination /path/to/source/folder -templatedir /path/to/EOGenerator/templates -java -packagedirs

Voila. EOGenerator will spit out your Java files for you. Let's break down the commands you can pass in:

29

30

* --define--EOGenericRecord <class>, allows you to specify the //Person class's superclass. For instance, if you use Project Wonder, you would specify --define--EOGenericRecord er.extensions.ERXGenericRecord//

31

* --destination <path>, the folder that //Person.java//--//style java files will be produced in (the non-editable files)//

32

* --java, produce java files--

33

* --javaTemplate <filename>, the name of the Java template to use inside of the template dir (//Person)//--

34

* --model <path>, Passes in the path of a .eomodeld you would like to generate Java files for. You can actually include multiple --model commands on the commandline

35

* --packagedirs, produce package directory for any package statements defined in your Java files (not necessary if you don't specify package names on your entities. By the way, you should specify packages on your entities :) )--

36

* --refmodel <path>, Passes in the path of an .eomodeld that is required for generating Java files, but that won't actually have Java files generated for it. For instance, you should --refmodel any prototypes, or any models in other frameworks that you depend on

37

* --subclassDestination <path>, the folder that Person.java--style java files will be produced in (the editable files)

38

* --subclassJavaTemplate <filename>, the name of the Java subclass template to use inside of the template dir (Person)--

39

* --templatedir <path>, the path to the folder that contains EOGenerator templates--

40

* --verbose, turn on verbose output--

41

42

== Custom EOGenerator Mods ==

=== Zak Burke ===

Allow setting nulls on a to-one relationship (and turn it into a remove). Note, this is also included in Jonathan Rentzsch's templates.

public void save<$ToOneRelationship.name.initialCapitalString$>(<$ToOneRelationship.destinationEntity.referenceJavaClassName$> value)

{

if (value == null)

{

<$ToOneRelationship.destinationEntity.referenceJavaClassName$> object = <$ToOneRelationship.name$>();

55

if (object != null)

56

removeObjectFromBothSidesOfRelationshipWithKey(object, "<$ToOneRelationship.name$>");

}

else

{

addObjectToBothSidesOfRelationshipWithKey(value, "<$ToOneRelationship.name$>");

}

}

=== Chuck Hill ===

Return the list of changes between the current EO and the last committed version of the EO:

public NSDictionary changedProperties() {

73

NSDictionary commitedValues = editingContext().committedSnapshotForObject(this);

74

return changesFromSnapshot(commitedValues);

}

=== Jonathan Rentzsch ===

80

81

Jonathan Rentzsch has provided his base EOGenerator templates, which are a must-have:

82

83

http:~/~/rentzsch.com/share/eogenerator52templates.zip

84

85

=== Markus Ruggiero ===

86

87

Constants for all attributes and relationships. This allows compile time error checking in situations like

88

addObjecttoBothSidesOfRelationshipWithKey(myObject, Person.TO//MANY//Children)

<$foreach attribute classAttributes.@reversedArray do$>

93

public static final String ATTRIBUTE_<$attribute.name$> = "<$attribute.name$>";<$endforeach do$>

<$foreach ToOneRelationship classToOneRelationships.@reversedArray do$>

public static final String TO_ONE_<$ToOneRelationship.name$> = "<$ToOneRelationship.name$>";<$endforeach do$>

<$foreach ToManyRelationship classToManyRelationships.@reversedArray do$>

public static final String TO_MANY_<$ToManyRelationship.name$> = "<$ToManyRelationship.name$>";<$endforeach do$>

We also make heavy use of the user info dictionary on entity and attribute level. Allows to generate customized methods and what not. One example is booleans that are stored in the DB as strings with values "true" and "false".

<$if attribute.userInfo.usage h1. booleanFlag $> // boolean accessors

118

public void <$attribute.userInfo.setterName$>(boolean newBoolean) {

119

set<$attribute.name.initialCapitalString$>(newBoolean ? "true" : "false");

120

}

121

122

public boolean <$attribute.userInfo.getterName$>() {

123

return "true".equals(<$attribute.name$>()) ? true : false;

}

// validation

public String validate<$attribute.name.initialCapitalString$>(String newValue) {

128

if ( newValue null ) {

129

return "false";

130

} else if ( !newValue.equals("true") && !newValue.equals("false") ) {

131

String errorMessage = MessageHandler.format("INVALID_BOOLEAN_FLAG <$classNameWithoutPackage$>.<$attribute.name$>", null);

132

throw new NSValidation.ValidationException(errorMessage);

}

return newValue;

}

<$endif$>

=== Mike Schrag ===

Add a constant that represents the name of the entity so that you can refer to Person.ENTITY//NAME in fetches rather than the String (allows refactoring support in Eclipse)~://

public static final String ENTITY_NAME = "<$name$>";

Add a static factory method to your EO's ( Person createPerson(...) ) that shows you what required attributes and relationships are configured for you entity (attempts to provide a replacement "constructor" since EO constructors are empty):

public static <$classNameWithoutPackage$> create<$classNameWithoutPackage$>(EOEditingContext _editingContext<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>, <$Attribute.javaValueClassName$> _<$Attribute.name$><$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>, <$ToOneRelationship.destinationEntity.referenceJavaClassName$> _<$ToOneRelationship.name$><$endif$><$endforeach do$>) {

155

<$classNameWithoutPackage$> eoObject = (<$classNameWithoutPackage$>)EOUtilities.createAndInsertInstance(_editingContext, <$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME);<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>

156

eoObject.set<$Attribute.name.initialCapitalString$>(_<$Attribute.name$>);<$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>

157

eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(_<$ToOneRelationship.name$>);<$endif$><$endforeach do$>

return eoObject;

}

Here's a little bitty fancier (read: nastier) version that also handles superclass mandatory attributes and fields (one level). It skips any attribute that is referenced in the restricting qualifier of your subclass (since you are probably going to set that in your awakeFromInsertion):

public static <$classNameWithoutPackage$> create<$classNameWithoutPackage$>(EOEditingContext editingContext<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>, <$Attribute.javaValueClassName$> <$Attribute.name$><$endif$><$endforeach do$><$foreach Attribute parentEntity.classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$><$set RestrictingQualifierKey = false$><$foreach QualifierKey restrictingQualifier.allQualifierKeys do$><$if Attribute.name = QualifierKey$><$set RestrictingQualifierKey = true$><$endif$><$endforeach do$><$if RestrictingQualifierKey = false$>, <$Attribute.javaValueClassName$> <$Attribute.name$><$endif$><$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>, <$ToOneRelationship.destinationEntity.referenceJavaClassName$> <$ToOneRelationship.name$><$endif$><$endforeach do$><$foreach ToOneRelationship parentEntity.classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>, <$ToOneRelationship.destinationEntity.referenceJavaClassName$> <$ToOneRelationship.name$><$endif$><$endforeach do$>) {

168

<$classNameWithoutPackage$> eoObject = (<$classNameWithoutPackage$>)EOUtilities.createAndInsertInstance(editingContext, <$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME);<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>

169

eoObject.set<$Attribute.name.initialCapitalString$>(<$Attribute.name$>);<$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>

170

eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(<$ToOneRelationship.name$>);<$endif$><$endforeach do$><$foreach Attribute parentEntity.classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$><$set RestrictingQualifierKey = false$><$foreach QualifierKey restrictingQualifier.allQualifierKeys do$><$if Attribute.name = QualifierKey$><$set RestrictingQualifierKey = true$><$endif$><$endforeach do$><$if RestrictingQualifierKey = false$>

171

eoObject.set<$Attribute.name.initialCapitalString$>(<$Attribute.name$>);<$endif$><$endif$><$endforeach do$><$foreach ToOneRelationship parentEntity.classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>

172

eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(<$ToOneRelationship.name$>);<$endif$><$endforeach do$>

return eoObject;

}

Add a bunch of convience fetch methods (fetchAllPersons, fetchRequiredPerson, and other variants). It's not smart about pluralization, so it's just going to put an "s" on the end of the entity name:

public static NSArray fetchAll<$classNameWithoutPackage$>s(EOEditingContext _editingContext) {

183

return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetchAll<$classNameWithoutPackage$>s(_editingContext, null);

}

public static NSArray fetchAll<$classNameWithoutPackage$>s(EOEditingContext //editingContext, NSArray //sortOrderings) {

return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>s(_editingContext, null, _sortOrderings);

}

public static NSArray fetch<$classNameWithoutPackage$>s(EOEditingContext //editingContext, EOQualifier //qualifier, NSArray //sortOrderings) {//

EOFetchSpecification fetchSpec = new EOFetchSpecification(<$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME, _qualifier, _sortOrderings);

202

fetchSpec.setIsDeep(true);

203

NSArray eoObjects = _editingContext.objectsWithFetchSpecification(fetchSpec);

return eoObjects;

}

public static <$classNameWithoutPackage$> fetch<$classNameWithoutPackage$>(EOEditingContext //editingContext, String //keyName, Object //value) {//

return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>(_editingContext, new EOKeyValueQualifier(_keyName, EOQualifier.QualifierOperatorEqual, _value));

}

public static <$classNameWithoutPackage$> fetch<$classNameWithoutPackage$>(EOEditingContext //editingContext, EOQualifier //qualifier) {

NSArray eoObjects = <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>s(_editingContext, _qualifier, null);

223

<$classNameWithoutPackage$> eoObject;

224

int count = eoObjects.count();

if (count == 0) {

eoObject = null;

}

else if (count == 1) {

229

eoObject = (<$classNameWithoutPackage$>)eoObjects.objectAtIndex(0);

230

}

231

else {

232

throw new IllegalStateException("There was more than one <$classNameWithoutPackage$> that matched the qualifier '" + _qualifier + "'.");

}

return eoObject;

}

public static <$classNameWithoutPackage$> fetchRequired<$classNameWithoutPackage$>(EOEditingContext _editingContext, String _keyName, Object _value) {

238

return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetchRequired<$classNameWithoutPackage$>(_editingContext, new EOKeyValueQualifier(_keyName, EOQualifier.QualifierOperatorEqual, _value));

}

public static <$classNameWithoutPackage$> fetchRequired<$classNameWithoutPackage$>(EOEditingContext //editingContext, EOQualifier //qualifier) {

<$classNameWithoutPackage$> eoObject = <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>(_editingContext, _qualifier);

248

if (eoObject h1. null) {

249

throw new NoSuchElementException("There was no <$classNameWithoutPackage$> that matched the qualifier '" + _qualifier + "'.");

}

return eoObject;

}

Add methods for getting local instances of EO's. The static one is handy if you have a reference to an EO that might be null (it does a null check first):

public <$classNameWithoutPackage$> localInstanceOf<$classNameWithoutPackage$>(EOEditingContext _editingContext) {

261

return (<$classNameWithoutPackage$>)EOUtilities.localInstanceOfObject(_editingContext, this);

}

public static <$classNameWithoutPackage$> localInstanceOf<$classNameWithoutPackage$>(EOEditingContext //editingContext, <$classNameWithoutPackage$> //eo) {

return (_eo null) ? null : (<$classNameWithoutPackage$>)EOUtilities.localInstanceOfObject(_editingContext, _eo);

}

If you've ever wanted to be able to qualify a toMany relationship on your EO's, but sometimes you want to fetch them w/ a fetch spec, and sometimes you want to filter in-memory, you can use the following:

<$if !ToManyRelationship.inverseRelationship$>

280

public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier) {

281

return <$ToManyRelationship.name$>(qualifier, null);

282

}

283

<$endif$>

284

<$if ToManyRelationship.inverseRelationship$>

285

public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier) {

286

return <$ToManyRelationship.name$>(qualifier, null, false);

287

}

288

289

public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier, boolean fetch) {

290

return <$ToManyRelationship.name$>(qualifier, null, fetch);

}

<$endif$>

public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier, NSArray sortOrderings<$if ToManyRelationship.inverseRelationship$>, boolean fetch<$endif$>) {

295

NSArray results;

296

<$if ToManyRelationship.inverseRelationship$>

297

if (fetch) {

298

EOQualifier fullQualifier;

299

EOQualifier inverseQualifier = new EOKeyValueQualifier(<$ToManyRelationship.destination.className$>.<$ToManyRelationship.inverseRelationship.name.uppercaseUnderbarString$>_KEY, EOQualifier.QualifierOperatorEqual, this);

300

if (qualifier == null) {

301

fullQualifier = inverseQualifier;

302

}

303

else {

304

NSMutableArray qualifiers = new NSMutableArray();

305

qualifiers.addObject(qualifier);

306

qualifiers.addObject(inverseQualifier);

307

fullQualifier = new EOAndQualifier(qualifiers);

308

}

309

results = <$ToManyRelationship.destination.className$>.fetch<$ToManyRelationship.destination.name$>s(editingContext(), fullQualifier, sortOrderings);

}

else {

<$endif$>

results = <$ToManyRelationship.name$>();

314

if (qualifier != null) {

315

results = EOQualifier.filteredArrayWithQualifier(results, qualifier);

316

}

317

if (sortOrderings != null) {

318

results = EOSortOrdering.sortedArrayUsingKeyOrderArray(results, sortOrderings);

319

}

320

<$if ToManyRelationship.inverseRelationship$>

}

<$endif$>

return results;

}

=== John Huss ===

I wanted to share a wonderful bit of knowledge I learned today. If you're using Java 1.5 you can add @SuppressWarnings("all") to the template for your //EO base classes and eliminate annoying compiler messages (usually uneeded import statements).//

@SuppressWarnings("all")

335

public class _Invoice extends ERXGenericRecord {

}

=== Guido Neitzer ===

341

342

Create awakeFromInsertion() and awakeFromFetch() in your EOGenerator template as a method stub that only calls super() and has a comment for "initialize your object here ...". You only have to put in the code at that place and can't possibly forget to call super(). Here is an example:

/**

* Initialization of the instance while inserting it into an editing context

348

*/

349

public void awakeFromInsertion (EOEditingContext editingContext) {

350