Entity.Definition (JMinor Framework API 0.12.5-SNAPSHOT)

All Superinterfaces:

java.io.Serializable

Enclosing interface:

Entity
```
public static interface Entity.Definition
extends java.io.Serializable
```
Specifies a entity definition.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Entity.Definition.Builder
Builds a Entity.Definition

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Entity.Definition.Builder` Builds a Entity.Definition

Field Summary

Fields
Modifier and Type	Field and Description
`static PropertyValue<java.lang.Boolean>`	`STRICT_FOREIGN_KEYS` Specifies that it should not be possible to define foreign keys referencing entities that have not been defined, this can be disabled in case of entities with circular references Value type: Boolean Default value: true

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`compareTo(Entity entity, Entity entityToCompare)` Compares the given entities.
`java.lang.Class`	`getBeanClass()` Returns the bean class associated with this entity type
`java.lang.String`	`getCaption()`
`java.lang.Object`	`getColor(Entity entity, Property property)`
`java.util.List<ColumnProperty>`	`getColumnProperties()`
`java.util.List<ColumnProperty>`	`getColumnProperties(java.util.List<java.lang.String> propertyIds)` Returns the `ColumnProperty`s identified by the propertyIds in `propertyIds`
`ColumnProperty`	`getColumnProperty(java.lang.String propertyId)`
`java.util.Comparator<Entity>`	`getComparator()`
`Entity.ConditionProvider`	`getConditionProvider(java.lang.String conditionId)` Returns the `Entity.ConditionProvider` associated with the given id
`java.util.List<DenormalizedProperty>`	`getDenormalizedProperties(java.lang.String foreignKeyPropertyId)` Retrieves the denormalized properties which values originate from the entity referenced by the given foreign key property
`java.util.Collection<DerivedProperty>`	`getDerivedProperties(java.lang.String propertyId)` Returns the properties which values are derived from the value of the given property, an empty collection if no such derived properties exist
`java.lang.String`	`getDomainId()`
`java.lang.String`	`getEntityId()`
`java.util.List<ForeignKeyProperty>`	`getForeignKeyProperties()`
`java.util.List<ForeignKeyProperty>`	`getForeignKeyProperties(java.lang.String foreignEntityId)` Returns the foreign key properties referencing entities of the given type
`ForeignKeyProperty`	`getForeignKeyProperty(java.lang.String propertyId)`
`java.lang.String`	`getGroupByClause()`
`java.lang.String`	`getHavingClause()`
`Entity.KeyGenerator`	`getKeyGenerator()`
`Entity.KeyGenerator.Type`	`getKeyGeneratorType()`
`Entity.OrderBy`	`getOrderBy()`
`java.util.List<ColumnProperty>`	`getPrimaryKeyProperties()`
`java.util.Map<java.lang.String,ColumnProperty>`	`getPrimaryKeyPropertyMap()`
`java.util.List<Property>`	`getProperties()`
`java.util.List<Property>`	`getProperties(boolean includeHidden)` Returns all `Property`s for the given entity
`java.util.List<Property>`	`getProperties(java.util.Collection<java.lang.String> propertyIds)` Returns the `Property`s identified by the propertyIds in `propertyIds`
`Property`	`getProperty(java.lang.String propertyId)`
`java.util.Map<java.lang.String,Property>`	`getPropertyMap()`
`java.util.Collection<ColumnProperty>`	`getSearchProperties()` Returns the properties to search by when looking up entities of the type identified by `entityId`
`java.util.Collection<java.lang.String>`	`getSearchPropertyIds()`
`java.util.List<ColumnProperty>`	`getSelectableColumnProperties()`
`java.util.List<ColumnProperty>`	`getSelectableColumnProperties(java.util.Collection<java.lang.String> propertyIds)` Returns the selectable `ColumnProperty`s identified by the propertyIds in `propertyIds`
`ColumnProperty`	`getSelectableColumnProperty(java.lang.String propertyId)`
`java.lang.String`	`getSelectQuery()`
`java.lang.String`	`getSelectTableName()`
`Entity.ToString`	`getStringProvider()`
`java.lang.String`	`getTableName()`
`java.util.List<TransientProperty>`	`getTransientProperties()`
`java.util.List<Property>`	`getUpdatableProperties()`
`Entity.Validator`	`getValidator()`
`java.util.List<Property>`	`getVisibleProperties()`
`java.util.List<ColumnProperty>`	`getWritableColumnProperties(boolean includePrimaryKeyProperties, boolean includeNonUpdatable)` Retrieves the writable (non read-only) column properties comprising this entity type
`boolean`	`hasDenormalizedProperties()`
`boolean`	`hasDenormalizedProperties(java.lang.String foreignKeyPropertyId)`
`boolean`	`hasDerivedProperties()`
`boolean`	`hasDerivedProperties(java.lang.String propertyId)` Returns true if this entity contains properties which values are derived from the value of the given property
`boolean`	`hasSingleIntegerPrimaryKey()`
`boolean`	`isPrimaryKeyAutoGenerated()` Returns true if the value for the primary key of this entity is automatically generated, either by the framework, such as values queried from sequences or set by triggers.
`boolean`	`isReadOnly()`
`boolean`	`isSmallDataset()`
`boolean`	`isStaticData()`
`boolean`	`selectQueryContainsWhereClause()`
`java.lang.String`	`toString(Entity entity)`

- Field Detail
  - STRICT_FOREIGN_KEYS
```
static final PropertyValue<java.lang.Boolean> STRICT_FOREIGN_KEYS
```
    Specifies that it should not be possible to define foreign keys referencing entities that have not been defined, this can be disabled in case of entities with circular references
    Value type: Boolean
    Default value: true
- Method Detail
  - getEntityId
```
java.lang.String getEntityId()
```
    Returns:
    
    the entity ID
  - getTableName
```
java.lang.String getTableName()
```
    Returns:
    
    the name of the underlying table, with schema prefix if applicable
  - getConditionProvider
```
Entity.ConditionProvider getConditionProvider(java.lang.String conditionId)
```
    Returns the Entity.ConditionProvider associated with the given id
    
    Parameters:
    
    conditionId - the condition id
    
    Returns:
    
    the condition provider associated with the given id
    
    Throws:
    
    java.lang.IllegalArgumentException - in case no ConditionProvider is associated with the given conditionId
  - getDomainId
```
java.lang.String getDomainId()
```
    Returns:
    
    the ID of the domain this entity type belongs to
  - getValidator
```
Entity.Validator getValidator()
```
    Returns:
    
    the validator for this entity type
  - getCaption
```
java.lang.String getCaption()
```
    Returns:
    
    the caption to use when presenting entities of this type
  - getBeanClass
```
java.lang.Class getBeanClass()
```
    Returns the bean class associated with this entity type
    
    Returns:
    
    the bean class
  - isSmallDataset
```
boolean isSmallDataset()
```
    Returns:
    
    true if the underlying table is small enough for displaying the contents in a combo box
  - isStaticData
```
boolean isStaticData()
```
    Returns:
    
    true if the data in the underlying table can be regarded as static
  - isReadOnly
```
boolean isReadOnly()
```
    Returns:
    
    true if this entity type is read only
  - getKeyGenerator
```
Entity.KeyGenerator getKeyGenerator()
```
    Returns:
    
    the object responsible for generating primary key values for entities of this type
  - getKeyGeneratorType
```
Entity.KeyGenerator.Type getKeyGeneratorType()
```
    Returns:
    
    the type of key generator used for generating primary key values for entities of this type
  - isPrimaryKeyAutoGenerated
```
boolean isPrimaryKeyAutoGenerated()
```
    Returns true if the value for the primary key of this entity is automatically generated, either by the framework, such as values queried from sequences or set by triggers. If not the primary key value must be set manually before the entity is inserted.
    
    Returns:
    
    true if the value for the primary key is automatically generated
  - getOrderBy
```
Entity.OrderBy getOrderBy()
```
    Returns:
    
    the default order by clause to use when querying entities of this type
  - getGroupByClause
```
java.lang.String getGroupByClause()
```
    Returns:
    
    the group by clause to use when querying entities of this type, without the "group by" keywords
  - getHavingClause
```
java.lang.String getHavingClause()
```
    Returns:
    
    the having clause to use when querying entities of this type, without the "having" keyword
  - getSelectTableName
```
java.lang.String getSelectTableName()
```
    Returns:
    
    the name of the table to use when selecting entities of this type
  - getSelectQuery
```
java.lang.String getSelectQuery()
```
    Returns:
    
    the select query to use when selecting entities of this type
  - selectQueryContainsWhereClause
```
boolean selectQueryContainsWhereClause()
```
    Returns:
    
    true if the select query, if any, contains a where clause
  - getStringProvider
```
Entity.ToString getStringProvider()
```
    Returns:
    
    the object responsible for providing toString values for this entity type
  - getComparator
```
java.util.Comparator<Entity> getComparator()
```
    Returns:
    
    the comparator used when comparing this entity type to other entities
  - getSearchPropertyIds
```
java.util.Collection<java.lang.String> getSearchPropertyIds()
```
    Returns:
    
    a collection of property IDs identifying the properties to use when performing a default lookup for this entity type
  - getPropertyMap
```
java.util.Map<java.lang.String,Property> getPropertyMap()
```
    Returns:
    
    the properties for this entity type mapped to propertyIds
  - getProperties
```
java.util.List<Property> getProperties()
```
    Returns:
    
    a unmodifiable list view of the properties
  - hasDerivedProperties
```
boolean hasDerivedProperties()
```
    Returns:
    
    true if this entity contains any properties which values are derived from other properties
  - hasDerivedProperties
```
boolean hasDerivedProperties(java.lang.String propertyId)
```
    Returns true if this entity contains properties which values are derived from the value of the given property
    
    Parameters:
    
    propertyId - the ID of the property
    
    Returns:
    
    true if any properties are derived from the given property
  - getDerivedProperties
```
java.util.Collection<DerivedProperty> getDerivedProperties(java.lang.String propertyId)
```
    Returns the properties which values are derived from the value of the given property, an empty collection if no such derived properties exist
    
    Parameters:
    
    propertyId - the ID of the property
    
    Returns:
    
    a collection containing the properties which are derived from the given property
  - getPrimaryKeyProperties
```
java.util.List<ColumnProperty> getPrimaryKeyProperties()
```
    Returns:
    
    the primary key properties of this entity type, sorted by primary key column index
  - getPrimaryKeyPropertyMap
```
java.util.Map<java.lang.String,ColumnProperty> getPrimaryKeyPropertyMap()
```
    Returns:
    
    a map containing the primary key properties mapped to their respective propertyIds
  - getVisibleProperties
```
java.util.List<Property> getVisibleProperties()
```
    Returns:
    
    a list containing the visible properties for this entity type
  - getColumnProperties
```
java.util.List<ColumnProperty> getColumnProperties()
```
    Returns:
    
    a list containing the column-based properties for this entity type
  - getSelectableColumnProperties
```
java.util.List<ColumnProperty> getSelectableColumnProperties()
```
    Returns:
    
    a list containing the column properties to include in select queries
  - getTransientProperties
```
java.util.List<TransientProperty> getTransientProperties()
```
    Returns:
    
    a list containing the non-column-based properties for this entity type
  - getForeignKeyProperties
```
java.util.List<ForeignKeyProperty> getForeignKeyProperties()
```
    Returns:
    
    a list containing the foreign key properties for this entity type
  - hasDenormalizedProperties
```
boolean hasDenormalizedProperties()
```
    Returns:
    
    true if this entity type has any denormalized properties
  - hasDenormalizedProperties
```
boolean hasDenormalizedProperties(java.lang.String foreignKeyPropertyId)
```
    Parameters:
    
    foreignKeyPropertyId - the ID of the foreign key property
    
    Returns:
    
    true if this entity type has any denormalized properties associated with the give foreign key
  - getDenormalizedProperties
```
java.util.List<DenormalizedProperty> getDenormalizedProperties(java.lang.String foreignKeyPropertyId)
```
    Retrieves the denormalized properties which values originate from the entity referenced by the given foreign key property
    
    Parameters:
    
    foreignKeyPropertyId - the foreign key property ID
    
    Returns:
    
    a list containing the denormalized properties which values originate from the entity referenced by the given foreign key property
  - getSearchProperties
```
java.util.Collection<ColumnProperty> getSearchProperties()
```
    Returns the properties to search by when looking up entities of the type identified by entityId
    
    Returns:
    
    the properties to use when searching
    
    See Also:
    
    Entity.Definition.Builder.setSearchPropertyIds(String...)
  - getColumnProperty
```
ColumnProperty getColumnProperty(java.lang.String propertyId)
```
    Parameters:
    
    propertyId - the property id
    
    Returns:
    
    the column property identified by property id
    
    Throws:
    
    java.lang.IllegalArgumentException - in case the propertyId does not represent a ColumnProperty
  - getProperty
```
Property getProperty(java.lang.String propertyId)
```
    Parameters:
    
    propertyId - the property id
    
    Returns:
    
    the property identified by propertyId in the entity identified by entityId
    
    Throws:
    
    java.lang.IllegalArgumentException - in case no such property exists
  - getProperties
```
java.util.List<Property> getProperties(java.util.Collection<java.lang.String> propertyIds)
```
    Returns the Propertys identified by the propertyIds in propertyIds
    
    Parameters:
    
    propertyIds - the ids of the properties to retrieve
    
    Returns:
    
    a list containing the properties identified by propertyIds, found in the entity identified by entityId
  - getSelectableColumnProperty
```
ColumnProperty getSelectableColumnProperty(java.lang.String propertyId)
```
    Parameters:
    
    propertyId - the property id
    
    Returns:
    
    the column property identified by property id
    
    Throws:
    
    java.lang.IllegalArgumentException - in case the propertyId does not represent a ColumnProperty or if it is not selectable
    
    See Also:
    
    ColumnProperty.isSelectable()
  - getColumnProperties
```
java.util.List<ColumnProperty> getColumnProperties(java.util.List<java.lang.String> propertyIds)
```
    Returns the ColumnPropertys identified by the propertyIds in propertyIds
    
    Parameters:
    
    propertyIds - the ids of the properties to retrieve
    
    Returns:
    
    a list containing all column properties found in the entity identified by entityId, that is, properties that map to database columns, an empty list if none exist
  - hasSingleIntegerPrimaryKey
```
boolean hasSingleIntegerPrimaryKey()
```
    Returns:
    
    true if the primary key of the given type of entity is comprised of a single integer value
  - getWritableColumnProperties
```
java.util.List<ColumnProperty> getWritableColumnProperties(boolean includePrimaryKeyProperties,
                                                           boolean includeNonUpdatable)
```
    Retrieves the writable (non read-only) column properties comprising this entity type
    
    Parameters:
    
    includePrimaryKeyProperties - if true primary key properties are included, non-updatable primary key properties are only included if includeNonUpdatable is true
    
    includeNonUpdatable - if true then non updatable properties are included
    
    Returns:
    
    a list containing the writable column properties (properties that map to database columns) comprising the entity identified by entityId
  - getUpdatableProperties
```
java.util.List<Property> getUpdatableProperties()
```
    Returns:
    
    a list containing all updatable properties associated with the given entity id
  - getProperties
```
java.util.List<Property> getProperties(boolean includeHidden)
```
    Returns all Propertys for the given entity
    
    Parameters:
    
    includeHidden - true if hidden properties should be included in the result
    
    Returns:
    
    a list containing the properties found in the entity identified by entityId
  - getSelectableColumnProperties
```
java.util.List<ColumnProperty> getSelectableColumnProperties(java.util.Collection<java.lang.String> propertyIds)
```
    Returns the selectable ColumnPropertys identified by the propertyIds in propertyIds
    
    Parameters:
    
    propertyIds - the ids of the properties to retrieve
    
    Returns:
    
    a list containing all column properties found in the entity identified by entityId, that is, properties that map to database columns, an empty list if none exist
  - getForeignKeyProperties
```
java.util.List<ForeignKeyProperty> getForeignKeyProperties(java.lang.String foreignEntityId)
```
    Returns the foreign key properties referencing entities of the given type
    
    Parameters:
    
    foreignEntityId - the id of the referenced entity
    
    Returns:
    
    a List containing the properties, an empty list is returned in case no properties fit the condition
  - getForeignKeyProperty
```
ForeignKeyProperty getForeignKeyProperty(java.lang.String propertyId)
```
    Parameters:
    
    propertyId - the property id
    
    Returns:
    
    the Property.ForeignKeyProperty with the given propertyId
    
    Throws:
    
    java.lang.IllegalArgumentException - in case no such property exists
  - compareTo
```
int compareTo(Entity entity,
              Entity entityToCompare)
```
    Compares the given entities.
    
    Parameters:
    
    entity - the first entity
    
    entityToCompare - the second entity
    
    Returns:
    
    the compare result
  - toString
```
java.lang.String toString(Entity entity)
```
    Parameters:
    
    entity - the entity
    
    Returns:
    
    a string representation of the given entity
  - getColor
```
java.lang.Object getColor(Entity entity,
                          Property property)
```
    Parameters:
    
    entity - the entity
    
    property - the property
    
    Returns:
    
    the background color to use for this entity and property, null if none is specified

Interface Entity.Definition

Nested Class Summary

Field Summary

Method Summary

Field Detail

STRICT_FOREIGN_KEYS

Method Detail

getEntityId

getTableName

getConditionProvider

getDomainId

getValidator

getCaption

getBeanClass

isSmallDataset

isStaticData

isReadOnly

getKeyGenerator

getKeyGeneratorType

isPrimaryKeyAutoGenerated

getOrderBy

getGroupByClause

getHavingClause

getSelectTableName

getSelectQuery

selectQueryContainsWhereClause

getStringProvider

getComparator

getSearchPropertyIds

getPropertyMap

getProperties

hasDerivedProperties

hasDerivedProperties

getDerivedProperties

getPrimaryKeyProperties

getPrimaryKeyPropertyMap

getVisibleProperties

getColumnProperties

getSelectableColumnProperties

getTransientProperties

getForeignKeyProperties

hasDenormalizedProperties

hasDenormalizedProperties

getDenormalizedProperties

getSearchProperties

getColumnProperty

getProperty

getProperties

getSelectableColumnProperty

getColumnProperties

hasSingleIntegerPrimaryKey

getWritableColumnProperties

getUpdatableProperties

getProperties

getSelectableColumnProperties

getForeignKeyProperties

getForeignKeyProperty

compareTo

toString

getColor