Skip to Content
Version 28.1 by Quinton Dolan on 2007/07/16 22:26
Show last authors
1 |=Contents
2 |
3
4 {{toc style="disc" minLevel="2"}}{{/toc}}
5
6 == Overview ==
7
8 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.
9
10 == Advantages ==
11
12 There are several advantages to using EOGenerator over EOModeler's default Java file generation and merging with FileMerge.
13
14 * 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.
15 * 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.
16 * As David LaBer put it, "all the cool kids use it - and we all know looking cool is the **most** important criteria".
17
18 == How To Use It ==
19
20 Kieran Kelleher has writtten an [[Introduction to EOGenerator>>http://homepage.mac.com/kelleherk/iblog/C1837526061/E1908382110/index.html]] on his blog.
21
22 It's actually very simple to use. The quick start is:
23
24 * Download and untar EOGenerator from the Rubicode site
25 * Run the following command:
26
27 {{panel}}
28
29 eogenerator -model /path/to/model/YourModel.eomodeld -destination /path/to/source/folder
30 -subclassDestination /path/to/source/folder -templatedir /path/to/EOGenerator/templates -java -packagedirs
31
32 {{/panel}}
33
34 Voila. EOGenerator will spit out your Java files for you. Let's break down the commands you can pass in:
35
36 * --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//
37 * --destination <path>, the folder that //Person.java//--//style java files will be produced in (the non-editable files)//
38 * --java, produce java files--
39 * --javaTemplate <filename>, the name of the Java template to use inside of the template dir (//Person)//--
40 * --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
41 * --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 :) )--
42 * --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
43 * --subclassDestination <path>, the folder that Person.java--style java files will be produced in (the editable files)
44 * --subclassJavaTemplate <filename>, the name of the Java subclass template to use inside of the template dir (Person)--
45 * --templatedir <path>, the path to the folder that contains EOGenerator templates--
46 * --verbose, turn on verbose output--
47
48 == Custom EOGenerator Mods ==
49
50 === Zak Burke ===
51
52 Allow setting nulls on a to-one relationship (and turn it into a remove). Note, this is also included in Jonathan Rentzsch's templates.
53
54 {{code}}
55
56 public void save<$ToOneRelationship.name.initialCapitalString$>(<$ToOneRelationship.destinationEntity.referenceJavaClassName$> value)
57 {
58 if (value == null)
59 {
60 <$ToOneRelationship.destinationEntity.referenceJavaClassName$> object = <$ToOneRelationship.name$>();
61 if (object != null)
62 removeObjectFromBothSidesOfRelationshipWithKey(object, "<$ToOneRelationship.name$>");
63 }
64 else
65 {
66 addObjectToBothSidesOfRelationshipWithKey(value, "<$ToOneRelationship.name$>");
67 }
68 }
69
70 {{/code}}
71
72 === Chuck Hill ===
73
74 Return the list of changes between the current EO and the last committed version of the EO:
75
76 {{code}}
77
78 public NSDictionary changedProperties() {
79 NSDictionary commitedValues = editingContext().committedSnapshotForObject(this);
80 return changesFromSnapshot(commitedValues);
81 }
82
83 {{/code}}
84
85 === Jonathan Rentzsch ===
86
87 Jonathan Rentzsch has provided his base EOGenerator templates, which are a must-have:
88
89 http:~/~/rentzsch.com/share/eogenerator52templates.zip
90
91 === Markus Ruggiero ===
92
93 Constants for all attributes and relationships. This allows compile time error checking in situations like
94 addObjecttoBothSidesOfRelationshipWithKey(myObject, Person.TO//MANY//Children)
95
96 {{code}}
97
98 <$foreach attribute classAttributes.@reversedArray do$>
99 public static final String ATTRIBUTE_<$attribute.name$> = "<$attribute.name$>";<$endforeach do$>
100
101 <$foreach ToOneRelationship classToOneRelationships.@reversedArray do$>
102 public static final String TO_ONE_<$ToOneRelationship.name$> = "<$ToOneRelationship.name$>";<$endforeach do$>
103
104 <$foreach ToManyRelationship classToManyRelationships.@reversedArray do$>
105 public static final String TO_MANY_<$ToManyRelationship.name$> = "<$ToManyRelationship.name$>";<$endforeach do$>
106
107 {{/code}}
108
109 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".
110
111 {{code}}
112
113 <$if attribute.userInfo.usage h1. booleanFlag $> // boolean accessors
114 public void <$attribute.userInfo.setterName$>(boolean newBoolean) {
115 set<$attribute.name.initialCapitalString$>(newBoolean ? "true" : "false");
116 }
117
118 public boolean <$attribute.userInfo.getterName$>() {
119 return "true".equals(<$attribute.name$>()) ? true : false;
120 }
121
122 // validation
123 public String validate<$attribute.name.initialCapitalString$>(String newValue) {
124 if ( newValue null ) {
125 return "false";
126 } else if ( !newValue.equals("true") && !newValue.equals("false") ) {
127 String errorMessage = MessageHandler.format("INVALID_BOOLEAN_FLAG <$classNameWithoutPackage$>.<$attribute.name$>", null);
128 throw new NSValidation.ValidationException(errorMessage);
129 }
130 return newValue;
131 }
132 <$endif$>
133
134 {{/code}}
135
136 === Mike Schrag ===
137
138 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)~://
139
140 {{code}}
141
142 public static final String ENTITY_NAME = "<$name$>";
143
144 {{/code}}
145
146 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):
147
148 {{code bar="true"}}
149
150 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$>) {
151 <$classNameWithoutPackage$> eoObject = (<$classNameWithoutPackage$>)EOUtilities.createAndInsertInstance(_editingContext, <$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME);<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>
152 eoObject.set<$Attribute.name.initialCapitalString$>(_<$Attribute.name$>);<$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
153 eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(_<$ToOneRelationship.name$>);<$endif$><$endforeach do$>
154 return eoObject;
155 }
156
157 {{/code}}
158
159 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):
160
161 {{code bar="true"}}
162
163 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$>) {
164 <$classNameWithoutPackage$> eoObject = (<$classNameWithoutPackage$>)EOUtilities.createAndInsertInstance(editingContext, <$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME);<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>
165 eoObject.set<$Attribute.name.initialCapitalString$>(<$Attribute.name$>);<$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
166 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$>
167 eoObject.set<$Attribute.name.initialCapitalString$>(<$Attribute.name$>);<$endif$><$endif$><$endforeach do$><$foreach ToOneRelationship parentEntity.classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
168 eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(<$ToOneRelationship.name$>);<$endif$><$endforeach do$>
169 return eoObject;
170 }
171
172 {{/code}}
173
174 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:
175
176 {{code}}
177
178 public static NSArray fetchAll<$classNameWithoutPackage$>s(EOEditingContext _editingContext) {
179 return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetchAll<$classNameWithoutPackage$>s(_editingContext, null);
180 }
181
182 public static NSArray fetchAll<$classNameWithoutPackage$>s(EOEditingContext _editingContext, NSArray _sortOrderings) {
183 return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>s(_editingContext, null, _sortOrderings);
184 }
185
186 public static NSArray fetch<$classNameWithoutPackage$>s(EOEditingContext _editingContext, EOQualifier _qualifier, NSArray _sortOrderings) {
187 EOFetchSpecification fetchSpec = new EOFetchSpecification(<$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME, _qualifier, _sortOrderings);
188 fetchSpec.setIsDeep(true);
189 NSArray eoObjects = _editingContext.objectsWithFetchSpecification(fetchSpec);
190 return eoObjects;
191 }
192
193 public static <$classNameWithoutPackage$> fetch<$classNameWithoutPackage$>(EOEditingContext _editingContext, String _keyName, Object _value) {
194 return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>(_editingContext, new EOKeyValueQualifier(_keyName, EOQualifier.QualifierOperatorEqual, _value));
195 }
196
197 public static <$classNameWithoutPackage$> fetch<$classNameWithoutPackage$>(EOEditingContext _editingContext, EOQualifier _qualifier) {
198 NSArray eoObjects = <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>s(_editingContext, _qualifier, null);
199 <$classNameWithoutPackage$> eoObject;
200 int count = eoObjects.count();
201 if (count == 0) {
202 eoObject = null;
203 }
204 else if (count == 1) {
205 eoObject = (<$classNameWithoutPackage$>)eoObjects.objectAtIndex(0);
206 }
207 else {
208 throw new IllegalStateException("There was more than one <$classNameWithoutPackage$> that matched the qualifier '" + _qualifier + "'.");
209 }
210 return eoObject;
211 }
212
213 public static <$classNameWithoutPackage$> fetchRequired<$classNameWithoutPackage$>(EOEditingContext _editingContext, String _keyName, Object _value) {
214 return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetchRequired<$classNameWithoutPackage$>(_editingContext, new EOKeyValueQualifier(_keyName, EOQualifier.QualifierOperatorEqual, _value));
215 }
216
217 public static <$classNameWithoutPackage$> fetchRequired<$classNameWithoutPackage$>(EOEditingContext _editingContext, EOQualifier _qualifier) {
218 <$classNameWithoutPackage$> eoObject = <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>(_editingContext, _qualifier);
219 if (eoObject h1. null) {
220 throw new NoSuchElementException("There was no <$classNameWithoutPackage$> that matched the qualifier '" + _qualifier + "'.");
221 }
222 return eoObject;
223 }
224
225 {{/code}}
226
227 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):
228
229 {{code}}
230
231 public <$classNameWithoutPackage$> localInstanceOf<$classNameWithoutPackage$>(EOEditingContext _editingContext) {
232 return (<$classNameWithoutPackage$>)EOUtilities.localInstanceOfObject(_editingContext, this);
233 }
234
235 public static <$classNameWithoutPackage$> localInstanceOf<$classNameWithoutPackage$>(EOEditingContext _editingContext, <$classNameWithoutPackage$> _eo) {
236 return (_eo null) ? null : (<$classNameWithoutPackage$>)EOUtilities.localInstanceOfObject(_editingContext, _eo);
237 }
238
239 {{/code}}
240
241 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:
242
243 {{code}}
244
245 <$if !ToManyRelationship.inverseRelationship$>
246 public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier) {
247 return <$ToManyRelationship.name$>(qualifier, null);
248 }
249 <$endif$>
250 <$if ToManyRelationship.inverseRelationship$>
251 public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier) {
252 return <$ToManyRelationship.name$>(qualifier, null, false);
253 }
254
255 public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier, boolean fetch) {
256 return <$ToManyRelationship.name$>(qualifier, null, fetch);
257 }
258 <$endif$>
259
260 public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier, NSArray sortOrderings<$if ToManyRelationship.inverseRelationship$>, boolean fetch<$endif$>) {
261 NSArray results;
262 <$if ToManyRelationship.inverseRelationship$>
263 if (fetch) {
264 EOQualifier fullQualifier;
265 EOQualifier inverseQualifier = new EOKeyValueQualifier(<$ToManyRelationship.destination.className$>.
266 <$ToManyRelationship.inverseRelationship.name.uppercaseUnderbarString$>_KEY, EOQualifier.QualifierOperatorEqual, this);
267 if (qualifier == null) {
268 fullQualifier = inverseQualifier;
269 }
270 else {
271 NSMutableArray qualifiers = new NSMutableArray();
272 qualifiers.addObject(qualifier);
273 qualifiers.addObject(inverseQualifier);
274 fullQualifier = new EOAndQualifier(qualifiers);
275 }
276 results = <$ToManyRelationship.destination.className$>.fetch<$ToManyRelationship.destination.name$>s(editingContext(), fullQualifier, sortOrderings);
277 }
278 else {
279 <$endif$>
280 results = <$ToManyRelationship.name$>();
281 if (qualifier != null) {
282 results = EOQualifier.filteredArrayWithQualifier(results, qualifier);
283 }
284 if (sortOrderings != null) {
285 results = EOSortOrdering.sortedArrayUsingKeyOrderArray(results, sortOrderings);
286 }
287 <$if ToManyRelationship.inverseRelationship$>
288 }
289 <$endif$>
290 return results;
291 }
292
293 {{/code}}
294
295 === John Huss ===
296
297 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).//
298
299 {{code}}
300
301 @SuppressWarnings("all")
302 public class _Invoice extends ERXGenericRecord {
303 }
304
305 {{/code}}
306
307 === Guido Neitzer ===
308
309 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:
310
311 {{code}}
312
313 /**
314 * Initialization of the instance while inserting it into an editing context
315 */
316 public void awakeFromInsertion (EOEditingContext editingContext) {
317 super.awakeFromInsertion (editingContext);
318 // initialize your object here
319 }
320
321 {{/code}}
322
323 This is from my JavaSubclassSourceTemplate.eotemplate
324
325 Category:WebObjects