Changes for page EOF-Using EOF-EOGenerator

Last modified by Pascal Robert on 2012/01/21 22:03

From 13.1 to 12.1 From 30.1 to 29.1

From version 29.1

edited by Quinton Dolan
on 2007/07/16 22:26

Change comment: There is no comment for this version

To version 13.1

edited by smmccraw
on 2007/07/08 09:44

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.qdolan
++XWiki.smmccraw

Content

@@ -1,8 +6,3 @@
--|=Contents
--|
--
--{{toc style="disc" minLevel="2"}}{{/toc}}
--
  == 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.
@@ -26,8 +26,7 @@
  {{panel}}
--eogenerator -model /path/to/model/YourModel.eomodeld -destination /path/to/source/folder
--   -subclassDestination /path/to/source/folder -templatedir /path/to/EOGenerator/templates -java -packagedirs
++  eogenerator -model /path/to/model/YourModel.eomodeld -destination /path/to/source/folder -subclassDestination /path/to/source/folder -templatedir /path/to/EOGenerator/templates -java -packagedirs
  {{/panel}}
@@ -51,7 +51,7 @@
  Allow setting nulls on a to-one relationship (and turn it into a remove).  Note, this is also included in Jonathan Rentzsch's templates.
--{{code}}
++{{panel}}
    public void save<$ToOneRelationship.name.initialCapitalString$>(<$ToOneRelationship.destinationEntity.referenceJavaClassName$> value)
    {
@@ -67,13 +67,13 @@
      }
    }
--{{/code}}
++{{/panel}}
  === Chuck Hill  ===
  Return the list of changes between the current EO and the last committed version of the EO:
--{{code}}
++{{panel}}
    public NSDictionary changedProperties() {
      NSDictionary commitedValues = editingContext().committedSnapshotForObject(this);
@@ -80,7 +80,7 @@
      return changesFromSnapshot(commitedValues);
    }
--{{/code}}
++{{/panel}}
  === Jonathan Rentzsch  ===
@@ -93,22 +93,32 @@
  Constants for all attributes and relationships. This allows compile time error checking in situations like
  addObjecttoBothSidesOfRelationshipWithKey(myObject, Person.TO//MANY//Children)
--{{code}}
++{{panel}}
    <$foreach attribute classAttributes.@reversedArray do$>
      public static final String ATTRIBUTE_<$attribute.name$> = "<$attribute.name$>";<$endforeach do$>
++{{/panel}}
++
    <$foreach ToOneRelationship classToOneRelationships.@reversedArray do$>
++
++{{panel}}
++
      public static final String TO_ONE_<$ToOneRelationship.name$> = "<$ToOneRelationship.name$>";<$endforeach do$>
++{{/panel}}
++
    <$foreach ToManyRelationship classToManyRelationships.@reversedArray do$>
++
++{{panel}}
++
      public static final String TO_MANY_<$ToManyRelationship.name$> = "<$ToManyRelationship.name$>";<$endforeach do$>
--{{/code}}
++{{/panel}}
  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".
--{{code}}
++{{panel}}
    <$if attribute.userInfo.usage h1.  booleanFlag $>    // boolean accessors
      public void <$attribute.userInfo.setterName$>(boolean newBoolean) {
@@ -131,59 +131,69 @@
      }
    <$endif$>
--{{/code}}
++{{/panel}}
  === 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)~://
--{{code}}
++{{panel}}
    public static final String ENTITY_NAME = "<$name$>";
--{{/code}}
++{{/panel}}
  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):
--{{code bar="true"}}
++{{panel}}
--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$>) {
--   <$classNameWithoutPackage$> eoObject = (<$classNameWithoutPackage$>)EOUtilities.createAndInsertInstance(_editingContext, <$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME);<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>
--   eoObject.set<$Attribute.name.initialCapitalString$>(_<$Attribute.name$>);<$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
--   eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(_<$ToOneRelationship.name$>);<$endif$><$endforeach do$>
--   return eoObject;
--}
++  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$>) {
++    <$classNameWithoutPackage$> eoObject = (<$classNameWithoutPackage$>)EOUtilities.createAndInsertInstance(_editingContext, <$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME);<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>
++    eoObject.set<$Attribute.name.initialCapitalString$>(_<$Attribute.name$>);<$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
++    eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(_<$ToOneRelationship.name$>);<$endif$><$endforeach do$>
++    return eoObject;
++  }
--{{/code}}
++{{/panel}}
  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):
--{{code bar="true"}}
++{{panel}}
--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$>) {
--   <$classNameWithoutPackage$> eoObject = (<$classNameWithoutPackage$>)EOUtilities.createAndInsertInstance(editingContext, <$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME);<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>
--   eoObject.set<$Attribute.name.initialCapitalString$>(<$Attribute.name$>);<$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
--   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$>
--   eoObject.set<$Attribute.name.initialCapitalString$>(<$Attribute.name$>);<$endif$><$endif$><$endforeach do$><$foreach ToOneRelationship parentEntity.classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
--   eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(<$ToOneRelationship.name$>);<$endif$><$endforeach do$>
--   return eoObject;
--}
++  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$>) {
++    <$classNameWithoutPackage$> eoObject = (<$classNameWithoutPackage$>)EOUtilities.createAndInsertInstance(editingContext, <$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME);<$foreach Attribute classAttributes.@sortedNameArray do$><$if !Attribute.allowsNull$>
++    eoObject.set<$Attribute.name.initialCapitalString$>(<$Attribute.name$>);<$endif$><$endforeach do$><$foreach ToOneRelationship classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
++    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$>
++    eoObject.set<$Attribute.name.initialCapitalString$>(<$Attribute.name$>);<$endif$><$endif$><$endforeach do$><$foreach ToOneRelationship parentEntity.classToOneRelationships.@sortedNameArray do$><$if ToOneRelationship.isMandatory$>
++    eoObject.set<$ToOneRelationship.name.initialCapitalString$>Relationship(<$ToOneRelationship.name$>);<$endif$><$endforeach do$>
++    return eoObject;
++  }
--{{/code}}
++{{/panel}}
  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:
--{{code}}
++{{panel}}
    public static NSArray fetchAll<$classNameWithoutPackage$>s(EOEditingContext _editingContext) {
      return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetchAll<$classNameWithoutPackage$>s(_editingContext, null);
    }
--  public static NSArray fetchAll<$classNameWithoutPackage$>s(EOEditingContext _editingContext, NSArray _sortOrderings) {
++{{/panel}}
++
++  public static NSArray fetchAll<$classNameWithoutPackage$>s(EOEditingContext //editingContext, NSArray //sortOrderings) {
++
++{{panel}}
++
      return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>s(_editingContext, null, _sortOrderings);
    }
--  public static NSArray fetch<$classNameWithoutPackage$>s(EOEditingContext _editingContext, EOQualifier _qualifier, NSArray _sortOrderings) {
++{{/panel}}
++
++  public static NSArray fetch<$classNameWithoutPackage$>s(EOEditingContext //editingContext, EOQualifier //qualifier, NSArray //sortOrderings) {//
++
++{{panel}}
++
      EOFetchSpecification fetchSpec = new EOFetchSpecification(<$GEN_PREFIX$><$classNameWithoutPackage$>.ENTITY_NAME, _qualifier, _sortOrderings);
      fetchSpec.setIsDeep(true);
      NSArray eoObjects = _editingContext.objectsWithFetchSpecification(fetchSpec);
@@ -190,11 +190,21 @@
      return eoObjects;
    }
--  public static <$classNameWithoutPackage$> fetch<$classNameWithoutPackage$>(EOEditingContext _editingContext, String _keyName, Object _value) {
++{{/panel}}
++
++  public static <$classNameWithoutPackage$> fetch<$classNameWithoutPackage$>(EOEditingContext //editingContext, String //keyName, Object //value) {//
++
++{{panel}}
++
      return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>(_editingContext, new EOKeyValueQualifier(_keyName, EOQualifier.QualifierOperatorEqual, _value));
    }
--  public static <$classNameWithoutPackage$> fetch<$classNameWithoutPackage$>(EOEditingContext _editingContext, EOQualifier _qualifier) {
++{{/panel}}
++
++  public static <$classNameWithoutPackage$> fetch<$classNameWithoutPackage$>(EOEditingContext //editingContext, EOQualifier //qualifier) {
++
++{{panel}}
++
      NSArray eoObjects = <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>s(_editingContext, _qualifier, null);
      <$classNameWithoutPackage$> eoObject;
      int count = eoObjects.count();
@@ -214,7 +214,12 @@
      return <$GEN_PREFIX$><$classNameWithoutPackage$>.fetchRequired<$classNameWithoutPackage$>(_editingContext, new EOKeyValueQualifier(_keyName, EOQualifier.QualifierOperatorEqual, _value));
    }
--  public static <$classNameWithoutPackage$> fetchRequired<$classNameWithoutPackage$>(EOEditingContext _editingContext, EOQualifier _qualifier) {
++{{/panel}}
++
++  public static <$classNameWithoutPackage$> fetchRequired<$classNameWithoutPackage$>(EOEditingContext //editingContext, EOQualifier //qualifier) {
++
++{{panel}}
++
      <$classNameWithoutPackage$> eoObject = <$GEN_PREFIX$><$classNameWithoutPackage$>.fetch<$classNameWithoutPackage$>(_editingContext, _qualifier);
      if (eoObject h1.  null) {
        throw new NoSuchElementException("There was no <$classNameWithoutPackage$> that matched the qualifier '" + _qualifier + "'.");
@@ -222,25 +222,30 @@
      return eoObject;
    }
--{{/code}}
++{{/panel}}
  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):
--{{code}}
++{{panel}}
    public <$classNameWithoutPackage$> localInstanceOf<$classNameWithoutPackage$>(EOEditingContext _editingContext) {
      return (<$classNameWithoutPackage$>)EOUtilities.localInstanceOfObject(_editingContext, this);
    }
--  public static <$classNameWithoutPackage$> localInstanceOf<$classNameWithoutPackage$>(EOEditingContext _editingContext, <$classNameWithoutPackage$> _eo) {
++{{/panel}}
++
++  public static <$classNameWithoutPackage$> localInstanceOf<$classNameWithoutPackage$>(EOEditingContext //editingContext, <$classNameWithoutPackage$> //eo) {
++
++{{panel}}
++
      return (_eo  null) ? null : (<$classNameWithoutPackage$>)EOUtilities.localInstanceOfObject(_editingContext, _eo);
    }
--{{/code}}
++{{/panel}}
  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:
--{{code}}
++{{panel}}
    <$if !ToManyRelationship.inverseRelationship$>
    	public NSArray <$ToManyRelationship.name$>(EOQualifier qualifier) {
@@ -262,8 +262,7 @@
    <$if ToManyRelationship.inverseRelationship$>
    		if (fetch) {
    			EOQualifier fullQualifier;
--  			EOQualifier inverseQualifier = new EOKeyValueQualifier(<$ToManyRelationship.destination.className$>.
--                <$ToManyRelationship.inverseRelationship.name.uppercaseUnderbarString$>_KEY, EOQualifier.QualifierOperatorEqual, this);
++  			EOQualifier inverseQualifier = new EOKeyValueQualifier(<$ToManyRelationship.destination.className$>.<$ToManyRelationship.inverseRelationship.name.uppercaseUnderbarString$>_KEY, EOQualifier.QualifierOperatorEqual, this);
    			if (qualifier == null) {
    				fullQualifier = inverseQualifier;
    			}
@@ -290,35 +290,35 @@
    		return results;
    	}
--{{/code}}
++{{/panel}}
  === 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).//
--{{code}}
++{{panel}}
    @SuppressWarnings("all")
    public class _Invoice extends ERXGenericRecord {
    }
--{{/code}}
++{{/panel}}
  === Guido Neitzer  ===
  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:
--{{code}}
++{{panel}}
--/**
-- * Initialization of the instance while inserting it into an editing context
-- */
--public void awakeFromInsertion (EOEditingContext editingContext) {
--    super.awakeFromInsertion (editingContext);
--    // initialize your object here
--}
++    /**
++     * Initialization of the instance while inserting it into an editing context
++     */
++     public void awakeFromInsertion (EOEditingContext editingContext) {
++         super.awakeFromInsertion (editingContext);
++         // initialize your object here
++     }
--{{/code}}
++{{/panel}}
  This is from my JavaSubclassSourceTemplate.eotemplate

Changes for page EOF-Using EOF-EOGenerator

Summary

Details

Applications

Navigation

My Recent Modifications

Need help?