|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface Entity.Definition
Specifies a entity definition.
Method Summary | |
---|---|
int |
compareTo(Entity entity,
Entity entityToCompare)
Compares the given entities. |
Color |
getBackgroundColor(Entity entity,
Property property)
|
String |
getCaption()
|
List<Property.ColumnProperty> |
getColumnProperties()
|
Entity.Comparator |
getComparator()
|
Collection<Property.DenormalizedProperty> |
getDenormalizedProperties(String foreignKeyPropertyID)
Retrieves the denormalized properties which values originate from the entity referenced by the given foreign key property |
String |
getDomainID()
|
String |
getEntityID()
|
List<Property.ForeignKeyProperty> |
getForeignKeyProperties()
|
IdSource |
getIdSource()
|
String |
getIdValueSource()
|
Collection<String> |
getLinkedPropertyIDs(String propertyID)
Returns the IDs of the properties which values are linked to the value of the given property, an empty collection if no such linked properties exist |
String |
getOrderByClause()
|
List<Property.PrimaryKeyProperty> |
getPrimaryKeyProperties()
|
Map<String,Property> |
getProperties()
|
List<String> |
getSearchPropertyIDs()
|
String |
getSelectColumnsString()
Retrieves the column list to use when constructing a select query for this entity type |
String |
getSelectQuery()
|
String |
getSelectTableName()
|
ValueMap.ToString<String> |
getStringProvider()
|
String |
getTableName()
|
List<Property.TransientProperty> |
getTransientProperties()
|
Entity.Validator |
getValidator()
|
List<Property> |
getVisibleProperties()
|
boolean |
hasDenormalizedProperties()
|
boolean |
hasDenormalizedProperties(String foreignKeyPropertyID)
|
boolean |
hasLinkedProperties(String propertyID)
Returns true if this entity contains properties which values are linked to the value of the given property |
boolean |
isReadOnly()
|
boolean |
isSmallDataset()
|
Entity.Definition |
setBackgroundColorProvider(Entity.BackgroundColorProvider colorProvider)
|
Entity.Definition |
setCaption(String caption)
Sets the caption for this entity type |
Entity.Definition |
setComparator(Entity.Comparator comparator)
Sets the comparator to use when comparing this entity type to other entities |
Entity.Definition |
setDomainID(String domainID)
Sets the domain ID for this entity type |
Entity.Definition |
setIdSource(IdSource idSource)
Sets the id source for this entity type, which specifies the primary key generation strategy to use. |
Entity.Definition |
setIdValueSource(String idValueSource)
Sets the id value source for this entity type, such as sequence or table name, depending on the underlying primary key generation strategy. |
Entity.Definition |
setOrderByClause(String orderByClause)
Sets the order by clause for this entity type, this clause should not include the "order by" keywords. |
Entity.Definition |
setReadOnly(boolean readOnly)
Sets the read only value |
Entity.Definition |
setSearchPropertyIDs(String... searchPropertyIDs)
Sets the IDs of the properties to use when performing a default lookup for this entity type |
Entity.Definition |
setSelectQuery(String selectQuery)
Sets the select query to use when selecting entities of this type, use with care. |
Entity.Definition |
setSelectTableName(String selectTableName)
Sets the name of the table to use when selecting entities of this type, when it differs from the one used to update/insert, such as a view. |
Entity.Definition |
setSmallDataset(boolean smallDataset)
Specifies whether or not this entity should be regarded as based on a small dataset, which primarily means that combo box models can be based on this entity. |
Entity.Definition |
setStringProvider(ValueMap.ToString<String> stringProvider)
Sets the string provider, that is, the object responsible for providing toString values for this entity type |
Entity.Definition |
setToStringProvider(ValueMap.ToString<String> toString)
|
Entity.Definition |
setValidator(Entity.Validator validator)
|
String |
toString(Entity entity)
|
Method Detail |
---|
String getEntityID()
String getTableName()
String getDomainID()
Entity.Definition setDomainID(String domainID)
domainID
- the domain ID
Entity.Definition setToStringProvider(ValueMap.ToString<String> toString)
toString
- the to string provider
Entity.Definition setBackgroundColorProvider(Entity.BackgroundColorProvider colorProvider)
colorProvider
- the background color provider
Entity.Definition setValidator(Entity.Validator validator)
validator
- the validator for this entity type
Entity.Validator getValidator()
String getCaption()
Entity.Definition setCaption(String caption)
caption
- the caption
boolean isSmallDataset()
Entity.Definition setSmallDataset(boolean smallDataset)
smallDataset
- true if the underlying table is small enough for displaying the contents in a combo box
boolean isReadOnly()
Entity.Definition setReadOnly(boolean readOnly)
readOnly
- true if this entity type should be read only
IdSource getIdSource()
Entity.Definition setIdSource(IdSource idSource)
idSource
- the idSource
String getIdValueSource()
Entity.Definition setIdValueSource(String idValueSource)
idValueSource
- the id value source
String getOrderByClause()
Entity.Definition setOrderByClause(String orderByClause)
orderByClause
- the order by clause
String getSelectTableName()
Entity.Definition setSelectTableName(String selectTableName)
selectTableName
- the name of the table
String getSelectQuery()
Entity.Definition setSelectQuery(String selectQuery)
selectQuery
- the select query to use for this entity type
ValueMap.ToString<String> getStringProvider()
Entity.Definition setStringProvider(ValueMap.ToString<String> stringProvider)
stringProvider
- the string provider
Entity.Definition setComparator(Entity.Comparator comparator)
comparator
- the comparator
Entity.Comparator getComparator()
List<String> getSearchPropertyIDs()
Entity.Definition setSearchPropertyIDs(String... searchPropertyIDs)
searchPropertyIDs
- the search property IDs
Map<String,Property> getProperties()
boolean hasLinkedProperties(String propertyID)
propertyID
- the ID of the property
Collection<String> getLinkedPropertyIDs(String propertyID)
propertyID
- the ID of the property
List<Property.PrimaryKeyProperty> getPrimaryKeyProperties()
String getSelectColumnsString()
List<Property> getVisibleProperties()
List<Property.ColumnProperty> getColumnProperties()
List<Property.TransientProperty> getTransientProperties()
List<Property.ForeignKeyProperty> getForeignKeyProperties()
boolean hasDenormalizedProperties()
boolean hasDenormalizedProperties(String foreignKeyPropertyID)
foreignKeyPropertyID
- the ID of the foreign key property
Collection<Property.DenormalizedProperty> getDenormalizedProperties(String foreignKeyPropertyID)
foreignKeyPropertyID
- the foreign key property ID
int compareTo(Entity entity, Entity entityToCompare)
entity
- the first entityentityToCompare
- the second entity
String toString(Entity entity)
entity
- the entity
Color getBackgroundColor(Entity entity, Property property)
entity
- the entityproperty
- the property
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |