Java Doc for ModelEntity.java in  » ERP-CRM-Financial » ofbiz » org » ofbiz » entity » model » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » ofbiz » org.ofbiz.entity.model 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.ofbiz.entity.model.ModelInfo
      org.ofbiz.entity.model.ModelEntity

All known Subclasses:   org.ofbiz.entity.model.ModelViewEntity,
ModelEntity
public class ModelEntity extends ModelInfo implements Comparable,Serializable(Code)
Generic Entity - Entity model class


Field Summary
final public static  StringCREATE_STAMP_FIELD
    
final public static  StringCREATE_STAMP_TX_FIELD
    
final public static  StringSTAMP_FIELD
    
final public static  StringSTAMP_TX_FIELD
    
protected  booleanautoClearCache
    
protected  StringdefaultResourceName
    
protected  StringdependentOn
    
protected  booleandoLock
    
protected  StringentityName
    
protected  Listfields
    
protected  MapfieldsMap
    
protected  Listindexes
    
protected  ModelReadermodelReader
    
final public static  Stringmodule
    
protected  booleanneverCache
     An indicator to specify if this entity is never cached.
protected  booleannoAutoStamp
    
protected  Listnopks
    
protected  StringpackageName
    
protected  Listpks
    
protected  Listrelations
    
protected  StringtableName
    
protected  MapviewEntities
    

Constructor Summary
public  ModelEntity()
    
protected  ModelEntity(ModelReader reader, Element entityElement, ModelInfo def)
    
public  ModelEntity(ModelReader reader, Element entityElement, UtilTimer utilTimer, ModelInfo def)
    
public  ModelEntity(String tableName, Map colMap, ModelFieldTypeReader modelFieldTypeReader, boolean isCaseSensitive)
    

Method Summary
public  voidaddExtendEntity(ModelReader reader, Element extendEntityElement)
    
public  voidaddField(ModelField field)
    
public  voidaddIndex(ModelIndex index)
    
public  voidaddRelation(ModelRelation relation)
    
public  voidaddViewEntity(ModelViewEntity view)
    
public  booleanareFields(Collection fieldNames)
    
public  StringclassNameString(List flds)
    
public  StringclassNameString(List flds, String separator, String afterLast)
    
public  StringcolNameString(List flds)
    
public  StringcolNameString(List flds, String separator, String afterLast, boolean alias)
    
public  intcompareTo(Object obj)
    
public  booleancontainsAllPkFieldNames(Set fieldNames)
    
public  voidconvertFieldMapInPlace(Map inContext, GenericDelegator delegator)
    
public  ObjectconvertFieldValue(String fieldName, Object value, GenericDelegator delegator)
    
public  ObjectconvertFieldValue(ModelField modelField, Object value, GenericDelegator delegator)
    
public  ListconvertToViewValues(String viewEntityName, GenericEntity entity)
    
protected synchronized  voidcreateFieldsMap()
    
public  StringfieldNameString()
    
public  StringfieldNameString(String separator, String afterLast)
    
public  StringfieldTypeNameString()
    
public  StringfieldsStringList(List flds, String eachString, String separator)
    
public  StringfieldsStringList(List flds, String eachString, String separator, boolean appendIndex)
    
public  StringfieldsStringList(List flds, String eachString, String separator, boolean appendIndex, boolean onlyNonPK)
    
public  StringfinderQueryString(List flds)
    
public  ListgetAllFieldNames()
    
public  booleangetAutoClearCache()
    
public  StringgetColNameOrAlias(String fieldName)
    
public  StringgetDefaultResourceName()
    
public  StringgetDependentOn()
    
public  booleangetDoLock()
    
public  StringgetEntityName()
    
public  ModelFieldgetField(int index)
    
public  ModelFieldgetField(String fieldName)
    
public  ListgetFieldNamesFromFieldVector(List modelFields)
    
public  ListgetFieldsCopy()
    
public  IteratorgetFieldsIterator()
    
public  intgetFieldsSize()
    
public  StringgetFirstPkFieldName()
    
public  ModelIndexgetIndex(int index)
    
public  ModelIndexgetIndex(String indexName)
    
public  IteratorgetIndexesIterator()
    
public  intgetIndexesSize()
    
public  ModelReadergetModelReader()
    
public  booleangetNeverCache()
     An indicator to specify if this entity is never cached.
public  booleangetNoAutoStamp()
    
public  ListgetNoPkFieldNames()
    
public  ModelFieldgetNopk(int index)
    
public  ListgetNopksCopy()
    
public  IteratorgetNopksIterator()
    
public  intgetNopksSize()
    
public  ModelFieldgetOnlyPk()
    
public  StringgetPackageName()
    
public  ModelFieldgetPk(int index)
    
public  ListgetPkFieldNames()
    
public  ListgetPksCopy()
    
public  IteratorgetPksIterator()
    
public  intgetPksSize()
    
public  StringgetPlainTableName()
    
public  ModelRelationgetRelation(int index)
    
public  ModelRelationgetRelation(String relationName)
    
public  IteratorgetRelationsIterator()
    
public  intgetRelationsOneSize()
    
public  intgetRelationsSize()
    
public  StringgetTableName(String helperName)
    
public  StringgetTableName(DatasourceInfo datasourceInfo)
    
public  IteratorgetViewConvertorsIterator()
    
public  intgetViewEntitiesSize()
    
public  ModelViewEntitygetViewEntity(String viewEntityName)
    
public  StringhttpArgList(List flds)
    
public  StringhttpArgListFromClass(List flds)
    
public  StringhttpArgListFromClass(List flds, String entityNameSuffix)
    
public  StringhttpRelationArgList(List flds, ModelRelation relation)
    
public  booleanisField(String fieldName)
    
public  booleanlock()
    
public  StringnameString(List flds)
    
public  StringnameString(List flds, String separator, String afterLast)
    
public  StringnonPkNullList()
    
public  StringpkNameString()
    
public  StringpkNameString(String separator, String afterLast)
    
protected  voidpopulateBasicInfo(Element entityElement)
    
protected  voidpopulateIndexes(Element entityElement)
    
protected  voidpopulateRelated(ModelReader reader, Element entityElement)
    
public  StringprimKeyClassNameString()
    
public  ModelFieldremoveField(int index)
    
public  ModelFieldremoveField(String fieldName)
    
public  ModelIndexremoveIndex(int index)
    
public  ModelRelationremoveRelation(int index)
    
public  ModelViewEntityremoveViewEntity(String viewEntityName)
    
public  ModelViewEntityremoveViewEntity(ModelViewEntity viewEntity)
    
public  voidsetAutoClearCache(boolean autoClearCache)
    
public  voidsetDefaultResourceName(String defaultResourceName)
    
public  voidsetDependentOn(String dependentOn)
    
public  voidsetDoLock(boolean doLock)
    
public  voidsetEntityName(String entityName)
    
public  voidsetNeverCache(boolean neverCache)
    
public  voidsetNoAutoStamp(boolean noAutoStamp)
    
public  voidsetPackageName(String packageName)
    
public  voidsetTableName(String tableName)
    
public  StringtoString()
    
public  ElementtoXmlElement(Document document, String packageName)
    
public  ElementtoXmlElement(Document document)
    
public  StringtypeNameString(List flds)
    
public  StringtypeNameStringRelatedAndMain(List flds, ModelRelation relation)
    
public  StringtypeNameStringRelatedNoMapped(List flds, ModelRelation relation)
    
public  voidupdatePkLists()
    

Field Detail
CREATE_STAMP_FIELD
final public static String CREATE_STAMP_FIELD(Code)



CREATE_STAMP_TX_FIELD
final public static String CREATE_STAMP_TX_FIELD(Code)



STAMP_FIELD
final public static String STAMP_FIELD(Code)
The name of the time stamp field for locking/syncronization



STAMP_TX_FIELD
final public static String STAMP_TX_FIELD(Code)



autoClearCache
protected boolean autoClearCache(Code)



defaultResourceName
protected String defaultResourceName(Code)
The default-resource-name of the Entity, used with the getResource call to check for a value in a resource bundle



dependentOn
protected String dependentOn(Code)
The entity-name of the Entity that this Entity is dependent on, if empty then no dependency



doLock
protected boolean doLock(Code)
An indicator to specify if this entity requires locking for updates



entityName
protected String entityName(Code)
The entity-name of the Entity



fields
protected List fields(Code)
A List of the Field objects for the Entity



fieldsMap
protected Map fieldsMap(Code)



indexes
protected List indexes(Code)
indexes on fields/columns in this entity



modelReader
protected ModelReader modelReader(Code)
The ModelReader that created this Entity



module
final public static String module(Code)



neverCache
protected boolean neverCache(Code)
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



noAutoStamp
protected boolean noAutoStamp(Code)
Can be used to disable automatically creating update stamp fields and populating them on inserts and updates



nopks
protected List nopks(Code)
A List of the Field objects for the Entity, one for each NON Primary Key



packageName
protected String packageName(Code)
The package-name of the Entity



pks
protected List pks(Code)
A List of the Field objects for the Entity, one for each Primary Key



relations
protected List relations(Code)
relations defining relationships between this entity and other entities



tableName
protected String tableName(Code)
The table-name of the Entity



viewEntities
protected Map viewEntities(Code)
map of ModelViewEntities that references this model




Constructor Detail
ModelEntity
public ModelEntity()(Code)
Default Constructor



ModelEntity
protected ModelEntity(ModelReader reader, Element entityElement, ModelInfo def)(Code)
XML Constructor



ModelEntity
public ModelEntity(ModelReader reader, Element entityElement, UtilTimer utilTimer, ModelInfo def)(Code)
XML Constructor



ModelEntity
public ModelEntity(String tableName, Map colMap, ModelFieldTypeReader modelFieldTypeReader, boolean isCaseSensitive)(Code)
DB Names Constructor




Method Detail
addExtendEntity
public void addExtendEntity(ModelReader reader, Element extendEntityElement)(Code)



addField
public void addField(ModelField field)(Code)



addIndex
public void addIndex(ModelIndex index)(Code)



addRelation
public void addRelation(ModelRelation relation)(Code)



addViewEntity
public void addViewEntity(ModelViewEntity view)(Code)



areFields
public boolean areFields(Collection fieldNames)(Code)



classNameString
public String classNameString(List flds)(Code)



classNameString
public String classNameString(List flds, String separator, String afterLast)(Code)



colNameString
public String colNameString(List flds)(Code)



colNameString
public String colNameString(List flds, String separator, String afterLast, boolean alias)(Code)



compareTo
public int compareTo(Object obj)(Code)



containsAllPkFieldNames
public boolean containsAllPkFieldNames(Set fieldNames)(Code)



convertFieldMapInPlace
public void convertFieldMapInPlace(Map inContext, GenericDelegator delegator)(Code)



convertFieldValue
public Object convertFieldValue(String fieldName, Object value, GenericDelegator delegator)(Code)



convertFieldValue
public Object convertFieldValue(ModelField modelField, Object value, GenericDelegator delegator)(Code)



convertToViewValues
public List convertToViewValues(String viewEntityName, GenericEntity entity)(Code)



createFieldsMap
protected synchronized void createFieldsMap()(Code)



fieldNameString
public String fieldNameString()(Code)



fieldNameString
public String fieldNameString(String separator, String afterLast)(Code)



fieldTypeNameString
public String fieldTypeNameString()(Code)



fieldsStringList
public String fieldsStringList(List flds, String eachString, String separator)(Code)



fieldsStringList
public String fieldsStringList(List flds, String eachString, String separator, boolean appendIndex)(Code)



fieldsStringList
public String fieldsStringList(List flds, String eachString, String separator, boolean appendIndex, boolean onlyNonPK)(Code)



finderQueryString
public String finderQueryString(List flds)(Code)



getAllFieldNames
public List getAllFieldNames()(Code)



getAutoClearCache
public boolean getAutoClearCache()(Code)



getColNameOrAlias
public String getColNameOrAlias(String fieldName)(Code)
The col-name of the Field, the alias of the field if this is on a view-entity



getDefaultResourceName
public String getDefaultResourceName()(Code)
The default-resource-name of the Entity



getDependentOn
public String getDependentOn()(Code)
The entity-name of the Entity that this Entity is dependent on, if empty then no dependency



getDoLock
public boolean getDoLock()(Code)
An indicator to specify if this entity requires locking for updates



getEntityName
public String getEntityName()(Code)
The entity-name of the Entity



getField
public ModelField getField(int index)(Code)



getField
public ModelField getField(String fieldName)(Code)



getFieldNamesFromFieldVector
public List getFieldNamesFromFieldVector(List modelFields)(Code)



getFieldsCopy
public List getFieldsCopy()(Code)



getFieldsIterator
public Iterator getFieldsIterator()(Code)



getFieldsSize
public int getFieldsSize()(Code)



getFirstPkFieldName
public String getFirstPkFieldName()(Code)



getIndex
public ModelIndex getIndex(int index)(Code)



getIndex
public ModelIndex getIndex(String indexName)(Code)



getIndexesIterator
public Iterator getIndexesIterator()(Code)



getIndexesSize
public int getIndexesSize()(Code)



getModelReader
public ModelReader getModelReader()(Code)



getNeverCache
public boolean getNeverCache()(Code)
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



getNoAutoStamp
public boolean getNoAutoStamp()(Code)
Returns the noAutoStamp.



getNoPkFieldNames
public List getNoPkFieldNames()(Code)



getNopk
public ModelField getNopk(int index)(Code)



getNopksCopy
public List getNopksCopy()(Code)



getNopksIterator
public Iterator getNopksIterator()(Code)



getNopksSize
public int getNopksSize()(Code)



getOnlyPk
public ModelField getOnlyPk()(Code)



getPackageName
public String getPackageName()(Code)
The package-name of the Entity



getPk
public ModelField getPk(int index)(Code)



getPkFieldNames
public List getPkFieldNames()(Code)



getPksCopy
public List getPksCopy()(Code)



getPksIterator
public Iterator getPksIterator()(Code)



getPksSize
public int getPksSize()(Code)



getPlainTableName
public String getPlainTableName()(Code)
The plain table-name of the Entity without a schema name prefix



getRelation
public ModelRelation getRelation(int index)(Code)



getRelation
public ModelRelation getRelation(String relationName)(Code)



getRelationsIterator
public Iterator getRelationsIterator()(Code)



getRelationsOneSize
public int getRelationsOneSize()(Code)



getRelationsSize
public int getRelationsSize()(Code)



getTableName
public String getTableName(String helperName)(Code)
The table-name of the Entity including a Schema name if specified in the datasource config



getTableName
public String getTableName(DatasourceInfo datasourceInfo)(Code)
The table-name of the Entity including a Schema name if specified in the datasource config



getViewConvertorsIterator
public Iterator getViewConvertorsIterator()(Code)



getViewEntitiesSize
public int getViewEntitiesSize()(Code)



getViewEntity
public ModelViewEntity getViewEntity(String viewEntityName)(Code)



httpArgList
public String httpArgList(List flds)(Code)



httpArgListFromClass
public String httpArgListFromClass(List flds)(Code)



httpArgListFromClass
public String httpArgListFromClass(List flds, String entityNameSuffix)(Code)



httpRelationArgList
public String httpRelationArgList(List flds, ModelRelation relation)(Code)



isField
public boolean isField(String fieldName)(Code)



lock
public boolean lock()(Code)



nameString
public String nameString(List flds)(Code)



nameString
public String nameString(List flds, String separator, String afterLast)(Code)



nonPkNullList
public String nonPkNullList()(Code)



pkNameString
public String pkNameString()(Code)



pkNameString
public String pkNameString(String separator, String afterLast)(Code)



populateBasicInfo
protected void populateBasicInfo(Element entityElement)(Code)



populateIndexes
protected void populateIndexes(Element entityElement)(Code)



populateRelated
protected void populateRelated(ModelReader reader, Element entityElement)(Code)



primKeyClassNameString
public String primKeyClassNameString()(Code)



removeField
public ModelField removeField(int index)(Code)



removeField
public ModelField removeField(String fieldName)(Code)



removeIndex
public ModelIndex removeIndex(int index)(Code)



removeRelation
public ModelRelation removeRelation(int index)(Code)



removeViewEntity
public ModelViewEntity removeViewEntity(String viewEntityName)(Code)



removeViewEntity
public ModelViewEntity removeViewEntity(ModelViewEntity viewEntity)(Code)



setAutoClearCache
public void setAutoClearCache(boolean autoClearCache)(Code)



setDefaultResourceName
public void setDefaultResourceName(String defaultResourceName)(Code)



setDependentOn
public void setDependentOn(String dependentOn)(Code)



setDoLock
public void setDoLock(boolean doLock)(Code)



setEntityName
public void setEntityName(String entityName)(Code)



setNeverCache
public void setNeverCache(boolean neverCache)(Code)



setNoAutoStamp
public void setNoAutoStamp(boolean noAutoStamp)(Code)

Parameters:
  noAutoStamp - The noAutoStamp to set.



setPackageName
public void setPackageName(String packageName)(Code)



setTableName
public void setTableName(String tableName)(Code)



toString
public String toString()(Code)



toXmlElement
public Element toXmlElement(Document document, String packageName)(Code)



toXmlElement
public Element toXmlElement(Document document)(Code)



typeNameString
public String typeNameString(List flds)(Code)



typeNameStringRelatedAndMain
public String typeNameStringRelatedAndMain(List flds, ModelRelation relation)(Code)



typeNameStringRelatedNoMapped
public String typeNameStringRelatedNoMapped(List flds, ModelRelation relation)(Code)



updatePkLists
public void updatePkLists()(Code)



Fields inherited from org.ofbiz.entity.model.ModelInfo
final public static ModelInfo DEFAULT(Code)(Java Doc)
protected String author(Code)(Java Doc)
protected String copyright(Code)(Java Doc)
protected ModelInfo def(Code)(Java Doc)
protected String description(Code)(Java Doc)
final public static String module(Code)(Java Doc)
protected String title(Code)(Java Doc)
protected String version(Code)(Java Doc)

Methods inherited from org.ofbiz.entity.model.ModelInfo
public String getAuthor()(Code)(Java Doc)
public String getCopyright()(Code)(Java Doc)
public String getDescription()(Code)(Java Doc)
public String getTitle()(Code)(Java Doc)
public String getVersion()(Code)(Java Doc)
public void populateFromAttributes(Element element)(Code)(Java Doc)
public void populateFromElements(Element element)(Code)(Java Doc)
public void setAuthor(String author)(Code)(Java Doc)
public void setCopyright(String copyright)(Code)(Java Doc)
public void setDescription(String description)(Code)(Java Doc)
public void setTitle(String title)(Code)(Java Doc)
public void setVersion(String version)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.