Package org.apache.ofbiz.entity.model
Class ModelEntity
java.lang.Object
org.apache.ofbiz.entity.model.ModelEntity
- All Implemented Interfaces:
Serializable
,Comparable<ModelEntity>
- Direct Known Subclasses:
ModelViewEntity
An object that models the
<entity>
element.- See Also:
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionDefault ConstructorModelEntity
(String tableName, Map<String, DatabaseUtil.ColumnCheckInfo> colMap, Map<String, DatabaseUtil.ReferenceCheckInfo> refMap, ModelFieldTypeReader modelFieldTypeReader, boolean isCaseSensitive) ModelEntity
(String tableName, Map<String, DatabaseUtil.ColumnCheckInfo> colMap, ModelFieldTypeReader modelFieldTypeReader, boolean isCaseSensitive) DB Names Constructorprotected
ModelEntity
(ModelReader reader) protected
ModelEntity
(ModelReader reader, ModelInfo modelInfo) ModelEntity
(ModelReader reader, Element entityElement, UtilTimer utilTimer, ModelInfo modelInfo) XML Constructorprotected
ModelEntity
(ModelReader reader, Element entityElement, ModelInfo modelInfo) XML Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
addExtendEntity
(ModelReader reader, Element extendEntityElement) Add extend entity.void
addField
(ModelField field) Add field.void
addIndex
(ModelIndex index) Add index.void
addRelation
(ModelRelation relation) Add relation.void
addViewEntity
(ModelViewEntity view) Add view entity.boolean
areFields
(Collection<String> fieldNames) Are fields boolean.classNameString
(String separator, String afterLast, ModelField... flds) Class name string string.classNameString
(List<ModelField> flds) Class name string string.classNameString
(List<ModelField> flds, String separator, String afterLast) Class name string string.classNameString
(ModelField... flds) Class name string string.colNameString
(StringBuilder sb, String prefix, String separator, String afterLast, boolean alias, ModelField... flds) Col name string string builder.colNameString
(StringBuilder sb, String prefix, ModelField... flds) Col name string string builder.colNameString
(String separator, String afterLast, boolean alias, ModelField... flds) Deprecated.colNameString
(List<ModelField> flds) Deprecated.colNameString
(List<ModelField> flds, StringBuilder sb, String prefix) Col name string string builder.colNameString
(List<ModelField> flds, StringBuilder sb, String prefix, String separator, String afterLast, boolean alias) Col name string string builder.colNameString
(List<ModelField> flds, String separator, String afterLast, boolean alias) Deprecated.colNameString
(ModelField... flds) Deprecated.int
compareTo
(ModelEntity otherModelEntity) boolean
containsAllPkFieldNames
(Set<String> fieldNames) Contains all pk field names boolean.void
convertFieldMapInPlace
(Map<String, Object> inContext, Delegator delegator) Convert field map in place.void
convertFieldMapInPlace
(Map<String, Object> inContext, ModelFieldTypeReader modelFieldTypeReader) Convert field map in place.convertFieldValue
(String fieldName, Object value, Delegator delegator) Convert field value object.convertFieldValue
(ModelField modelField, Object value, Delegator delegator) Convert field value object.convertFieldValue
(ModelField modelField, Object value, Delegator delegator, Map<String, ? extends Object> context) Convert a field value from one Java data type to another.convertFieldValue
(ModelField modelField, Object value, ModelFieldTypeReader modelFieldTypeReader, Map<String, ? extends Object> context) Convert a field value from one Java data type to another.convertToViewValues
(String viewEntityName, GenericEntity entity) Convert to view values list.createEoModelMap
(String entityPrefix, String helperName, Set<String> entityNameIncludeSet, ModelReader entityModelReader) Create eo model map map.Field name string string.fieldNameString
(String separator, String afterLast) Field name string string.fieldsStringList
(StringBuilder sb, String eachString, String separator, boolean appendIndex, boolean onlyNonPK, ModelField... flds) Fields string list string builder.fieldsStringList
(StringBuilder sb, String eachString, String separator, boolean appendIndex, ModelField... flds) Fields string list string builder.fieldsStringList
(StringBuilder sb, String eachString, String separator, ModelField... flds) Fields string list string builder.fieldsStringList
(String eachString, String separator, boolean appendIndex, boolean onlyNonPK, ModelField... flds) Deprecated.fieldsStringList
(String eachString, String separator, boolean appendIndex, ModelField... flds) Deprecated.fieldsStringList
(String eachString, String separator, ModelField... flds) Deprecated.fieldsStringList
(List<ModelField> flds, StringBuilder sb, String eachString, String separator) Fields string list string builder.fieldsStringList
(List<ModelField> flds, StringBuilder sb, String eachString, String separator, boolean appendIndex) Fields string list string builder.fieldsStringList
(List<ModelField> flds, StringBuilder sb, String eachString, String separator, boolean appendIndex, boolean onlyNonPK) Fields string list string builder.fieldsStringList
(List<ModelField> flds, String eachString, String separator) Deprecated.fieldsStringList
(List<ModelField> flds, String eachString, String separator, boolean appendIndex) Deprecated.fieldsStringList
(List<ModelField> flds, String eachString, String separator, boolean appendIndex, boolean onlyNonPK) Deprecated.Field type name string string.finderQueryString
(List<ModelField> flds) Finder query string string.finderQueryString
(ModelField... flds) Finder query string string.Gets all field names.Gets author.boolean
Gets auto clear cache.getColNameOrAlias
(String fieldName) The col-name of the Field, the alias of the field if this is on a view-entity @param fieldName the field nameGets copyright.Gets default resource name.The entity-name of the Entity that this Entity is dependent on, if empty then no dependencyGets description.boolean
An indicator to specify if this entity requires locking for updatesThe entity-name of the EntityGets field.Gets fields iterator.int
Gets fields size.Gets fields unmodifiable.Gets first pk field name.boolean
Gets has field with audit log.getIndex
(int index) Gets index.Gets index.Gets indexes iterator.int
Gets indexes size.Get the location of this entity's definitionGets model reader.boolean
An indicator to specify if this entity is never cached.boolean
An indicator to specific if this entity should ignore automatic DB checks.boolean
Gets no pk field names.Gets nopks copy.Gets nopks iterator.int
Gets nopks size.Gets only pk.The package-name of the EntityGets pk field names.Gets pk fields.Gets pk fields unmodifiable.Gets pks iterator.int
Gets pks size.The plain table-name of the Entity without a schema name prefixgetRelation
(int index) Gets relation.getRelation
(String relationName) Gets relation.Gets relations.Gets relations iterator.getRelationsList
(boolean includeOne, boolean includeOneNoFk, boolean includeMany) Gets relations list.Gets relations many list.Gets relations one list.int
Gets relations one size.int
Gets relations size.Gets sequence bank size.getTableName
(String helperName) The table-name of the Entity including a Schema name if specified in the datasource configgetTableName
(Datasource datasourceInfo) The table-name of the Entity including a Schema name if specified in the datasource configgetTitle()
Gets title.Gets version.Gets view convertors iterator.int
Gets view entities size.httpArgList
(List<ModelField> flds) Http arg list string.httpArgList
(ModelField... flds) Http arg list string.httpArgListFromClass
(String entityNameSuffix, ModelField... flds) Http arg list from class string.httpArgListFromClass
(List<ModelField> flds) Http arg list from class string.httpArgListFromClass
(List<ModelField> flds, String entityNameSuffix) Http arg list from class string.httpArgListFromClass
(ModelField... flds) Http arg list from class string.httpRelationArgList
(List<ModelField> flds, ModelRelation relation) Http relation arg list string.httpRelationArgList
(ModelRelation relation, ModelField... flds) Http relation arg list string.boolean
Is field boolean.boolean
lock()
Lock boolean.nameString
(List<ModelField> flds) Name string string.nameString
(List<ModelField> flds, String separator, String afterLast) Name string string.Non pk null list string.Pk name string string.pkNameString
(String separator, String afterLast) Pk name string string.protected void
populateBasicInfo
(Element entityElement) Populate basic info.protected void
populateIndexes
(Element entityElement) Populate indexes.protected void
populateRelated
(ModelReader reader, Element entityElement) Populate related.Prim key class name string string.removeField
(String fieldName) Remove field model field.removeIndex
(int index) Remove index model index.removeRelation
(int index) Remove relation model relation.boolean
removeViewEntity
(String viewEntityName) Remove view entity boolean.boolean
removeViewEntity
(ModelViewEntity viewEntity) Remove view entity boolean.void
setAutoClearCache
(boolean autoClearCache) Sets auto clear cache.void
setDependentOn
(String dependentOn) Sets dependent on.void
setDoLock
(boolean doLock) Sets do lock.void
setEntityName
(String entityName) Sets entity name.void
setLocation
(String location) Set the location of this entity's definitionvoid
setNeverCache
(boolean neverCache) Sets never cache.void
setNeverCheck
(boolean neverCheck) Sets never check.void
setNoAutoStamp
(boolean noAutoStamp) void
setPackageName
(String packageName) Sets package name.void
setTableName
(String tableName) Sets table name.toGroupXmlElement
(Document document, String packageName) To Group elements of a document in a packagetoString()
toXmlElement
(Document document, String packageName) To xml element element.typeNameString
(List<ModelField> flds) Type name string string.typeNameString
(ModelField... flds) Type name string string.typeNameStringRelatedAndMain
(List<ModelField> flds, ModelRelation relation) Type name string related and main string.typeNameStringRelatedAndMain
(ModelRelation relation, ModelField... flds) Type name string related and main string.typeNameStringRelatedNoMapped
(List<ModelField> flds, ModelRelation relation) Type name string related no mapped string.typeNameStringRelatedNoMapped
(ModelRelation relation, ModelField... flds) Type name string related no mapped string.void
writeEoModelText
(PrintWriter writer, String entityPrefix, String helperName, Set<String> entityNameIncludeSet, ModelReader entityModelReader) Writes entity model information in the Apple EOModelBundle format.
-
Field Details
-
STAMP_FIELD
The name of the time stamp field for locking/synchronization- See Also:
-
STAMP_TX_FIELD
- See Also:
-
CREATE_STAMP_FIELD
- See Also:
-
CREATE_STAMP_TX_FIELD
- See Also:
-
-
Constructor Details
-
ModelEntity
public ModelEntity()Default Constructor -
ModelEntity
-
ModelEntity
-
ModelEntity
XML Constructor -
ModelEntity
public ModelEntity(ModelReader reader, Element entityElement, UtilTimer utilTimer, ModelInfo modelInfo) XML Constructor -
ModelEntity
public ModelEntity(String tableName, Map<String, DatabaseUtil.ColumnCheckInfo> colMap, ModelFieldTypeReader modelFieldTypeReader, boolean isCaseSensitive) DB Names Constructor -
ModelEntity
public ModelEntity(String tableName, Map<String, DatabaseUtil.ColumnCheckInfo> colMap, Map<String, DatabaseUtil.ReferenceCheckInfo> refMap, ModelFieldTypeReader modelFieldTypeReader, boolean isCaseSensitive)
-
-
Method Details
-
populateBasicInfo
Populate basic info.- Parameters:
entityElement
- the entity element
-
populateRelated
Populate related.- Parameters:
reader
- the readerentityElement
- the entity element
-
populateIndexes
Populate indexes.- Parameters:
entityElement
- the entity element
-
containsAllPkFieldNames
Contains all pk field names boolean.- Parameters:
fieldNames
- the field names- Returns:
- the boolean
-
addExtendEntity
Add extend entity.- Parameters:
reader
- the readerextendEntityElement
- the extend entity element
-
getModelReader
Gets model reader.- Returns:
- the model reader
-
getEntityName
The entity-name of the Entity -
setEntityName
Sets entity name.- Parameters:
entityName
- the entity name
-
getPlainTableName
The plain table-name of the Entity without a schema name prefix -
getTableName
The table-name of the Entity including a Schema name if specified in the datasource config -
getTableName
The table-name of the Entity including a Schema name if specified in the datasource config -
setTableName
Sets table name.- Parameters:
tableName
- the table name
-
getPackageName
The package-name of the Entity -
setPackageName
Sets package name.- Parameters:
packageName
- the package name
-
getDependentOn
The entity-name of the Entity that this Entity is dependent on, if empty then no dependency -
setDependentOn
Sets dependent on.- Parameters:
dependentOn
- the dependent on
-
getNeverCache
public boolean getNeverCache()An indicator to specify if this entity is never cached. If true causes the delegator to not clear caches on write and to not get from cache on read showing a warning messages to that effect -
setNeverCache
public void setNeverCache(boolean neverCache) Sets never cache.- Parameters:
neverCache
- the never cache
-
getNeverCheck
public boolean getNeverCheck()An indicator to specific if this entity should ignore automatic DB checks. This should be set when the entity is mapped to a database view to prevent warnings and attempts to modify the schema. -
setNeverCheck
public void setNeverCheck(boolean neverCheck) Sets never check.- Parameters:
neverCheck
- the never check
-
getAutoClearCache
public boolean getAutoClearCache()Gets auto clear cache.- Returns:
- the auto clear cache
-
setAutoClearCache
public void setAutoClearCache(boolean autoClearCache) Sets auto clear cache.- Parameters:
autoClearCache
- the auto clear cache
-
getHasFieldWithAuditLog
public boolean getHasFieldWithAuditLog()Gets has field with audit log.- Returns:
- the has field with audit log
-
getLocation
Get the location of this entity's definition -
setLocation
Set the location of this entity's definition -
getDoLock
public boolean getDoLock()An indicator to specify if this entity requires locking for updates -
setDoLock
public void setDoLock(boolean doLock) Sets do lock.- Parameters:
doLock
- the do lock
-
lock
public boolean lock()Lock boolean.- Returns:
- the boolean
-
getSequenceBankSize
Gets sequence bank size.- Returns:
- the sequence bank size
-
isField
Is field boolean.- Parameters:
fieldName
- the field name- Returns:
- the boolean
-
areFields
Are fields boolean.- Parameters:
fieldNames
- the field names- Returns:
- the boolean
-
getPksSize
public int getPksSize()Gets pks size.- Returns:
- the pks size
-
getOnlyPk
Gets only pk.- Returns:
- the only pk
-
getPksIterator
Gets pks iterator.- Returns:
- the pks iterator
-
getPkFields
Gets pk fields.- Returns:
- the pk fields
-
getPkFieldsUnmodifiable
Gets pk fields unmodifiable.- Returns:
- the pk fields unmodifiable
-
getFirstPkFieldName
Gets first pk field name.- Returns:
- the first pk field name
-
getNopksSize
public int getNopksSize()Gets nopks size.- Returns:
- the nopks size
-
getNopksIterator
Gets nopks iterator.- Returns:
- the nopks iterator
-
getNopksCopy
Gets nopks copy.- Returns:
- the nopks copy
-
getFieldsSize
public int getFieldsSize()Gets fields size.- Returns:
- the fields size
-
getFieldsIterator
Gets fields iterator.- Returns:
- the fields iterator
-
getFieldsUnmodifiable
Gets fields unmodifiable.- Returns:
- the fields unmodifiable
-
getColNameOrAlias
The col-name of the Field, the alias of the field if this is on a view-entity @param fieldName the field name- Returns:
- the col name or alias
-
getField
Gets field.- Parameters:
fieldName
- the field name- Returns:
- the field
-
addField
Add field.- Parameters:
field
- the field
-
removeField
Remove field model field.- Parameters:
fieldName
- the field name- Returns:
- the model field
-
getAllFieldNames
Gets all field names.- Returns:
- the all field names
-
getPkFieldNames
Gets pk field names.- Returns:
- the pk field names
-
getNoPkFieldNames
Gets no pk field names.- Returns:
- the no pk field names
-
getAutomaticFieldNames
- Returns:
- field names list, managed by entity-engine
-
getRelationsSize
public int getRelationsSize()Gets relations size.- Returns:
- the relations size
-
getRelationsOneSize
public int getRelationsOneSize()Gets relations one size.- Returns:
- the relations one size
-
getRelation
Gets relation.- Parameters:
index
- the index- Returns:
- the relation
-
getRelationsIterator
Gets relations iterator.- Returns:
- the relations iterator
-
getRelationsList
public List<ModelRelation> getRelationsList(boolean includeOne, boolean includeOneNoFk, boolean includeMany) Gets relations list.- Parameters:
includeOne
- the include oneincludeOneNoFk
- the include one no fkincludeMany
- the include many- Returns:
- the relations list
-
getRelationsOneList
Gets relations one list.- Returns:
- the relations one list
-
getRelationsManyList
Gets relations many list.- Returns:
- the relations many list
-
getRelation
Gets relation.- Parameters:
relationName
- the relation name- Returns:
- the relation
-
addRelation
Add relation.- Parameters:
relation
- the relation
-
removeRelation
Remove relation model relation.- Parameters:
index
- the index- Returns:
- the model relation
-
getIndexesSize
public int getIndexesSize()Gets indexes size.- Returns:
- the indexes size
-
getIndex
Gets index.- Parameters:
index
- the index- Returns:
- the index
-
getIndexesIterator
Gets indexes iterator.- Returns:
- the indexes iterator
-
getIndex
Gets index.- Parameters:
indexName
- the index name- Returns:
- the index
-
addIndex
Add index.- Parameters:
index
- the index
-
removeIndex
Remove index model index.- Parameters:
index
- the index- Returns:
- the model index
-
getViewEntitiesSize
public int getViewEntitiesSize()Gets view entities size.- Returns:
- the view entities size
-
getViewConvertorsIterator
Gets view convertors iterator.- Returns:
- the view convertors iterator
-
addViewEntity
Add view entity.- Parameters:
view
- the view
-
convertToViewValues
public List<? extends Map<String,Object>> convertToViewValues(String viewEntityName, GenericEntity entity) Convert to view values list.- Parameters:
viewEntityName
- the view entity nameentity
- the entity- Returns:
- the list
-
removeViewEntity
Remove view entity boolean.- Parameters:
viewEntityName
- the view entity name- Returns:
- the boolean
-
removeViewEntity
Remove view entity boolean.- Parameters:
viewEntity
- the view entity- Returns:
- the boolean
-
nameString
Name string string.- Parameters:
flds
- the flds- Returns:
- the string
-
nameString
Name string string.- Parameters:
flds
- the fldsseparator
- the separatorafterLast
- the after last- Returns:
- the string
-
typeNameString
Type name string string.- Parameters:
flds
- the flds- Returns:
- the string
-
typeNameString
Type name string string.- Parameters:
flds
- the flds- Returns:
- the string
-
fieldNameString
Field name string string.- Returns:
- the string
-
fieldNameString
Field name string string.- Parameters:
separator
- the separatorafterLast
- the after last- Returns:
- the string
-
fieldTypeNameString
Field type name string string.- Returns:
- the string
-
primKeyClassNameString
Prim key class name string string.- Returns:
- the string
-
pkNameString
Pk name string string.- Returns:
- the string
-
pkNameString
Pk name string string.- Parameters:
separator
- the separatorafterLast
- the after last- Returns:
- the string
-
nonPkNullList
Non pk null list string.- Returns:
- the string
-
fieldsStringList
Deprecated.Fields string list string.- Parameters:
eachString
- the each stringseparator
- the separatorflds
- the flds- Returns:
- the string
-
fieldsStringList
public StringBuilder fieldsStringList(StringBuilder sb, String eachString, String separator, ModelField... flds) Fields string list string builder.- Parameters:
sb
- the sbeachString
- the each stringseparator
- the separatorflds
- the flds- Returns:
- the string builder
-
fieldsStringList
@Deprecated public String fieldsStringList(List<ModelField> flds, String eachString, String separator) Deprecated.Fields string list string.- Parameters:
flds
- the fldseachString
- the each stringseparator
- the separator- Returns:
- the string
-
fieldsStringList
public StringBuilder fieldsStringList(List<ModelField> flds, StringBuilder sb, String eachString, String separator) Fields string list string builder.- Parameters:
flds
- the fldssb
- the sbeachString
- the each stringseparator
- the separator- Returns:
- the string builder
-
fieldsStringList
@Deprecated public String fieldsStringList(String eachString, String separator, boolean appendIndex, ModelField... flds) Deprecated.Fields string list string.- Parameters:
eachString
- the each stringseparator
- the separatorappendIndex
- the append indexflds
- the flds- Returns:
- the string
-
fieldsStringList
public StringBuilder fieldsStringList(StringBuilder sb, String eachString, String separator, boolean appendIndex, ModelField... flds) Fields string list string builder.- Parameters:
sb
- the sbeachString
- the each stringseparator
- the separatorappendIndex
- the append indexflds
- the flds- Returns:
- the string builder
-
fieldsStringList
@Deprecated public String fieldsStringList(List<ModelField> flds, String eachString, String separator, boolean appendIndex) Deprecated.Fields string list string.- Parameters:
flds
- the fldseachString
- the each stringseparator
- the separatorappendIndex
- the append index- Returns:
- the string
-
fieldsStringList
public StringBuilder fieldsStringList(List<ModelField> flds, StringBuilder sb, String eachString, String separator, boolean appendIndex) Fields string list string builder.- Parameters:
flds
- the fldssb
- the sbeachString
- the each stringseparator
- the separatorappendIndex
- the append index- Returns:
- the string builder
-
fieldsStringList
@Deprecated public String fieldsStringList(String eachString, String separator, boolean appendIndex, boolean onlyNonPK, ModelField... flds) Deprecated.Fields string list string.- Parameters:
eachString
- the each stringseparator
- the separatorappendIndex
- the append indexonlyNonPK
- the only non pkflds
- the flds- Returns:
- the string
-
fieldsStringList
public StringBuilder fieldsStringList(StringBuilder sb, String eachString, String separator, boolean appendIndex, boolean onlyNonPK, ModelField... flds) Fields string list string builder.- Parameters:
sb
- the sbeachString
- the each stringseparator
- the separatorappendIndex
- the append indexonlyNonPK
- the only non pkflds
- the flds- Returns:
- the string builder
-
fieldsStringList
@Deprecated public String fieldsStringList(List<ModelField> flds, String eachString, String separator, boolean appendIndex, boolean onlyNonPK) Deprecated.Fields string list string.- Parameters:
flds
- the fldseachString
- the each stringseparator
- the separatorappendIndex
- the append indexonlyNonPK
- the only non pk- Returns:
- the string
-
fieldsStringList
public StringBuilder fieldsStringList(List<ModelField> flds, StringBuilder sb, String eachString, String separator, boolean appendIndex, boolean onlyNonPK) Fields string list string builder.- Parameters:
flds
- the fldssb
- the sbeachString
- the each stringseparator
- the separatorappendIndex
- the append indexonlyNonPK
- the only non pk- Returns:
- the string builder
-
colNameString
Deprecated.Col name string string.- Parameters:
flds
- the flds- Returns:
- the string
-
colNameString
Col name string string builder.- Parameters:
sb
- the sbprefix
- the prefixflds
- the flds- Returns:
- the string builder
-
colNameString
Deprecated.Col name string string.- Parameters:
flds
- the flds- Returns:
- the string
-
colNameString
Col name string string builder.- Parameters:
flds
- the fldssb
- the sbprefix
- the prefix- Returns:
- the string builder
-
colNameString
@Deprecated public String colNameString(String separator, String afterLast, boolean alias, ModelField... flds) Deprecated.Col name string string.- Parameters:
separator
- the separatorafterLast
- the after lastalias
- the aliasflds
- the flds- Returns:
- the string
-
colNameString
public StringBuilder colNameString(StringBuilder sb, String prefix, String separator, String afterLast, boolean alias, ModelField... flds) Col name string string builder.- Parameters:
sb
- the sbprefix
- the prefixseparator
- the separatorafterLast
- the after lastalias
- the aliasflds
- the flds- Returns:
- the string builder
-
colNameString
@Deprecated public String colNameString(List<ModelField> flds, String separator, String afterLast, boolean alias) Deprecated.Col name string string.- Parameters:
flds
- the fldsseparator
- the separatorafterLast
- the after lastalias
- the alias- Returns:
- the string
-
colNameString
public StringBuilder colNameString(List<ModelField> flds, StringBuilder sb, String prefix, String separator, String afterLast, boolean alias) Col name string string builder.- Parameters:
flds
- the fldssb
- the sbprefix
- the prefixseparator
- the separatorafterLast
- the after lastalias
- the alias- Returns:
- the string builder
-
classNameString
Class name string string.- Parameters:
flds
- the flds- Returns:
- the string
-
classNameString
Class name string string.- Parameters:
flds
- the flds- Returns:
- the string
-
classNameString
Class name string string.- Parameters:
separator
- the separatorafterLast
- the after lastflds
- the flds- Returns:
- the string
-
classNameString
Class name string string.- Parameters:
flds
- the fldsseparator
- the separatorafterLast
- the after last- Returns:
- the string
-
finderQueryString
Finder query string string.- Parameters:
flds
- the flds- Returns:
- the string
-
finderQueryString
Finder query string string.- Parameters:
flds
- the flds- Returns:
- the string
-
httpArgList
Http arg list string.- Parameters:
flds
- the flds- Returns:
- the string
-
httpArgList
Http arg list string.- Parameters:
flds
- the flds- Returns:
- the string
-
httpArgListFromClass
Http arg list from class string.- Parameters:
flds
- the flds- Returns:
- the string
-
httpArgListFromClass
Http arg list from class string.- Parameters:
flds
- the flds- Returns:
- the string
-
httpArgListFromClass
Http arg list from class string.- Parameters:
entityNameSuffix
- the entity name suffixflds
- the flds- Returns:
- the string
-
httpArgListFromClass
Http arg list from class string.- Parameters:
flds
- the fldsentityNameSuffix
- the entity name suffix- Returns:
- the string
-
httpRelationArgList
Http relation arg list string.- Parameters:
relation
- the relationflds
- the flds- Returns:
- the string
-
httpRelationArgList
Http relation arg list string.- Parameters:
flds
- the fldsrelation
- the relation- Returns:
- the string
-
typeNameStringRelatedNoMapped
Type name string related no mapped string.- Parameters:
relation
- the relationflds
- the flds- Returns:
- the string
-
typeNameStringRelatedNoMapped
Type name string related no mapped string.- Parameters:
flds
- the fldsrelation
- the relation- Returns:
- the string
-
typeNameStringRelatedAndMain
Type name string related and main string.- Parameters:
relation
- the relationflds
- the flds- Returns:
- the string
-
typeNameStringRelatedAndMain
Type name string related and main string.- Parameters:
flds
- the fldsrelation
- the relation- Returns:
- the string
-
compareTo
- Specified by:
compareTo
in interfaceComparable<ModelEntity>
-
convertFieldMapInPlace
Convert field map in place.- Parameters:
inContext
- the in contextdelegator
- the delegator
-
convertFieldMapInPlace
public void convertFieldMapInPlace(Map<String, Object> inContext, ModelFieldTypeReader modelFieldTypeReader) Convert field map in place.- Parameters:
inContext
- the in contextmodelFieldTypeReader
- the model field type reader
-
convertFieldValue
Convert field value object.- Parameters:
fieldName
- the field namevalue
- the valuedelegator
- the delegator- Returns:
- the object
-
convertFieldValue
Convert field value object.- Parameters:
modelField
- the model fieldvalue
- the valuedelegator
- the delegator- Returns:
- the object
-
convertFieldValue
public Object convertFieldValue(ModelField modelField, Object value, Delegator delegator, Map<String, ? extends Object> context) Convert a field value from one Java data type to another. This is the preferred method - which takes into consideration the user's locale and time zone (for conversions that require them).- Returns:
- the converted value
-
convertFieldValue
public Object convertFieldValue(ModelField modelField, Object value, ModelFieldTypeReader modelFieldTypeReader, Map<String, ? extends Object> context) Convert a field value from one Java data type to another. This is the preferred method - which takes into consideration the user's locale and time zone (for conversions that require them).- Returns:
- the converted value
-
getNoAutoStamp
public boolean getNoAutoStamp()- Returns:
- Returns the noAutoStamp.
-
setNoAutoStamp
public void setNoAutoStamp(boolean noAutoStamp) - Parameters:
noAutoStamp
- The noAutoStamp to set.
-
toString
-
toXmlElement
To xml element element.- Parameters:
document
- the documentpackageName
- the package name- Returns:
- the element
-
toGroupXmlElement
To Group elements of a document in a package- Parameters:
document
- the documentpackageName
- the name of the package where to group the elements of the document- Returns:
- the element
-
writeEoModelText
public void writeEoModelText(PrintWriter writer, String entityPrefix, String helperName, Set<String> entityNameIncludeSet, ModelReader entityModelReader) throws GenericEntityException Writes entity model information in the Apple EOModelBundle format. For document structure and definition see: http://developer.apple.com/documentation/InternetWeb/Reference/WO_BundleReference/ Articles/EOModelBundle.html For examples see the JavaRealEstate.framework and JavaBusinessLogic.framework packages which are in the /Library/Frameworks directory after installing the WebObjects Examples package (get latest version of WebObjects download for this). This is based on examples and documentation from WebObjects 5.4, downloaded 20080221.- Parameters:
writer
-entityPrefix
-helperName
-- Throws:
GenericEntityException
-
createEoModelMap
public Map<String,Object> createEoModelMap(String entityPrefix, String helperName, Set<String> entityNameIncludeSet, ModelReader entityModelReader) throws GenericEntityException Create eo model map map.- Parameters:
entityPrefix
- the entity prefixhelperName
- the helper nameentityNameIncludeSet
- the entity name include setentityModelReader
- the entity model reader- Returns:
- the map
- Throws:
GenericEntityException
- the generic entity exception
-
getAuthor
Gets author.- Returns:
- the author
-
getCopyright
Gets copyright.- Returns:
- the copyright
-
getDefaultResourceName
Gets default resource name.- Returns:
- the default resource name
-
getDescription
Gets description.- Returns:
- the description
-
getRelations
Gets relations.- Returns:
- the relations
-
getTitle
Gets title.- Returns:
- the title
-
getVersion
Gets version.- Returns:
- the version
-