EntityConfig (Celerio API)

java.lang.Object
- com.jaxio.celerio.configuration.entity.EntityConfig

All Implemented Interfaces:: CacheConfigGetter

public class EntityConfig
extends Object
implements CacheConfigGetter

Describes an entity config

Constructor Summary

Constructors
Constructor and Description

EntityConfig()

Constructors
Constructor and Description
`EntityConfig()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addColumnConfig(ColumnConfig columnConfig)`
`boolean`	`atLeastOneColumnConfigIsIndexed()`
`void`	`forceImplementsInterfacesToNullIfEmpty()` Convenient for hbm2celerio to avoid dead tags.
`void`	`forceUsagesToNullIfEmpty()` Convenient for hbm2celerio to avoid dead tags.
`AssociationDirection`	`getAssociationDirection()` It is pertinent only if this entity's table plays the role of a middle table in a many-to-many association.
`CacheConfig`	`getCacheConfig()` The 2d level cache configuration for this entity.
`CollectionType`	`getCollectionType()` You can override the default collection type for this entity
`Map<String,ColumnConfig>`	`getColumnConfigByColumnName()`
`ColumnConfig`	`getColumnConfigByColumnName(String columnName)`
`ColumnConfig`	`getColumnConfigByFieldName(String fieldName)`
`List<ColumnConfig>`	`getColumnConfigs()` This entity's columnConfigs.
`String`	`getComment()` The comment that will be inserted in this entity's JavaDoc.
`String`	`getCommentAsJavadoc()`
`String`	`getCommentAsJavadoc(String prepend)`
`List<CustomAnnotation>`	`getCustomAnnotations()` List of custom annotations to apply on this entity.
`String`	`getEntityName()` The JPA entity's type.
`ExtendsClass`	`getExtendsClass()` Specify the base class that this entity should extends.
`List<ImplementsInterface>`	`getImplementsInterfaces()` Specify the extra interfaces that this entity should implement.
`Boolean`	`getIndexed()` Should this entity be annotated with hibernate search @Indexed annotation?
`Inheritance`	`getInheritance()` Inheritance configuration.
`String`	`getLabel()` The base label for this entity.
`List<Label>`	`getLabels()` The labels for this entity.
`List<MetaAttribute>`	`getMetaAttributes()` Meta attributes are free form key value pairs.
`Boolean`	`getMiddleTable()` By convention a table is considered as a many-to-many middle table if it has two foreign keys and no other regular columns.
`String`	`getParentEntityName()`
`String`	`getRootPackage()` Allows you to override the default root package.
`String`	`getSequenceName()` Allows you to specify the sequence name to use in order to generate this entity pk value.
`String`	`getSubPackage()` When you define a sub-package, the resulting entity's package becomes ".domain.
`String`	`getTableName()` The underlying table name for the entity.
`List<String>`	`getUsages()` Free parameters.
`boolean`	`hasCollectionType()`
`boolean`	`hasColumnConfigs()`
`boolean`	`hasComment()`
`boolean`	`hasEntityName()`
`boolean`	`hasExtendsClass()`
`boolean`	`hasImplementsInterfaces()`
`boolean`	`hasInheritance()`
`boolean`	`hasMiddleTable()`
`boolean`	`hasParentEntityName()`
`boolean`	`hasSequenceName()`
`boolean`	`hasTableName()`
`boolean`	`hasTrueIndexed()`
`boolean`	`is(InheritanceType strategy)`
`void`	`setAssociationDirection(AssociationDirection associationDirection)`
`void`	`setCacheConfig(CacheConfig cacheConfig)`
`void`	`setCollectionType(CollectionType collectionType)`
`void`	`setColumnConfigByColumnName(Map<String,ColumnConfig> columnConfigByColumnName)`
`void`	`setColumnConfigs(List<ColumnConfig> columnConfigs)`
`void`	`setComment(String comment)`
`void`	`setCustomAnnotations(List<CustomAnnotation> customAnnotations)`
`void`	`setEntityName(String entityName)`
`void`	`setExtendsClass(ExtendsClass extendsClass)`
`void`	`setImplementsInterfaces(List<ImplementsInterface> implementsInterfaces)`
`void`	`setIndexed(Boolean indexed)`
`void`	`setInheritance(Inheritance inheritance)`
`void`	`setLabel(String label)`
`void`	`setLabels(List<Label> labels)`
`void`	`setLog(Log log)`
`void`	`setMetaAttributes(List<MetaAttribute> metaAttributes)`
`void`	`setMiddleTable(Boolean middleTable)`
`void`	`setRootPackage(String rootPackage)`
`void`	`setSequenceName(String sequenceName)`
`void`	`setSubPackage(String subPackage)`
`void`	`setTableName(String tableName)`
`void`	`setUsages(List<String> usages)`
`String`	`toString()`
`boolean`	`useFormFieldConfig()`
`boolean`	`useSearchFieldConfig()`
`boolean`	`useSearchResultConfig()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EntityConfig
```
public EntityConfig()
```
- Method Detail
  - getCacheConfig
```
public CacheConfig getCacheConfig()
```
    The 2d level cache configuration for this entity.
    
    Specified by:
    
    getCacheConfig in interface CacheConfigGetter
  - getUsages
```
public List<String> getUsages()
```
    Free parameters. Not used internally.
  - setUsages
```
public void setUsages(List<String> usages)
```
  - forceUsagesToNullIfEmpty
```
public void forceUsagesToNullIfEmpty()
```
    Convenient for hbm2celerio to avoid dead tags.
  - forceImplementsInterfacesToNullIfEmpty
```
public void forceImplementsInterfacesToNullIfEmpty()
```
    Convenient for hbm2celerio to avoid dead tags.
  - getEntityName
```
public String getEntityName()
```
    The JPA entity's type.
    For example, entityName="BankAccount".
    By default, the entity name is deduced from the table name.
    For example: 'bank_account' will become 'BankAccount';
  - hasEntityName
```
public boolean hasEntityName()
```
  - getSequenceName
```
public String getSequenceName()
```
    Allows you to specify the sequence name to use in order to generate this entity pk value. When a sequence name is provided the corresponding @SequenceGenerator and @GeneratedValue annotations are added to the primary key attribute.
  - hasSequenceName
```
public boolean hasSequenceName()
```
  - getTableName
```
public String getTableName()
```
    The underlying table name for the entity. If not set, inheritance must be configured.
  - hasTableName
```
public boolean hasTableName()
```
  - getIndexed
```
public Boolean getIndexed()
```
    Should this entity be annotated with hibernate search @Indexed annotation? False by default, unless if one columnConfig is marked as indexed.
  - hasTrueIndexed
```
public boolean hasTrueIndexed()
```
  - getLabels
```
public List<Label> getLabels()
```
    The labels for this entity. They appear in the entity properties file located under 'src/main/resources/localization/domain'.
  - atLeastOneColumnConfigIsIndexed
```
public boolean atLeastOneColumnConfigIsIndexed()
```
  - getMiddleTable
```
public Boolean getMiddleTable()
```
    By convention a table is considered as a many-to-many middle table if it has two foreign keys and no other regular columns. This attribute allows you to consider this table as a middle table, even if it has other regular columns. A regular column is a column that is neither a primary key nor a version (i.e. optimistic lock).
  - hasMiddleTable
```
public boolean hasMiddleTable()
```
  - getComment
```
public String getComment()
```
    The comment that will be inserted in this entity's JavaDoc.
  - getCommentAsJavadoc
```
public String getCommentAsJavadoc()
```
  - getCommentAsJavadoc
```
public String getCommentAsJavadoc(String prepend)
```
  - hasComment
```
public boolean hasComment()
```
  - getRootPackage
```
public String getRootPackage()
```
    Allows you to override the default root package.
    Example: com.yourcompany
  - getSubPackage
```
public String getSubPackage()
```
    When you define a sub-package, the resulting entity's package becomes ".domain." instead of ".domain". There is no sub-package by default.
  - getLabel
```
public String getLabel()
```
    The base label for this entity. You may either set it here or in a nested labels/label.
  - getAssociationDirection
```
public AssociationDirection getAssociationDirection()
```
    It is pertinent only if this entity's table plays the role of a middle table in a many-to-many association. In that case you can use this parameter to set the many-to-many association direction.
  - getInheritance
```
public Inheritance getInheritance()
```
    Inheritance configuration.
  - hasInheritance
```
public boolean hasInheritance()
```
  - hasParentEntityName
```
public boolean hasParentEntityName()
```
  - getParentEntityName
```
public String getParentEntityName()
```
  - getCollectionType
```
public CollectionType getCollectionType()
```
    You can override the default collection type for this entity
  - hasCollectionType
```
public boolean hasCollectionType()
```
  - getExtendsClass
```
public ExtendsClass getExtendsClass()
```
    Specify the base class that this entity should extends. Only for root entity.
  - hasExtendsClass
```
public boolean hasExtendsClass()
```
  - getImplementsInterfaces
```
public List<ImplementsInterface> getImplementsInterfaces()
```
    Specify the extra interfaces that this entity should implement.
  - hasImplementsInterfaces
```
public boolean hasImplementsInterfaces()
```
  - getMetaAttributes
```
public List<MetaAttribute> getMetaAttributes()
```
    Meta attributes are free form key value pairs.
  - getColumnConfigs
```
public List<ColumnConfig> getColumnConfigs()
```
    This entity's columnConfigs. Note that for entities without inheritance or for entities with a JOIN inheritance strategy, if a column is present in the table's meta data but has no corresponding entityConfig in this list, then an entityConfig is created by default and added automatically to this list.
  - hasColumnConfigs
```
public boolean hasColumnConfigs()
```
  - setColumnConfigs
```
public void setColumnConfigs(List<ColumnConfig> columnConfigs)
```
  - addColumnConfig
```
public void addColumnConfig(ColumnConfig columnConfig)
```
  - getColumnConfigByColumnName
```
public ColumnConfig getColumnConfigByColumnName(String columnName)
```
  - getColumnConfigByFieldName
```
public ColumnConfig getColumnConfigByFieldName(String fieldName)
```
  - getCustomAnnotations
```
public List<CustomAnnotation> getCustomAnnotations()
```
    List of custom annotations to apply on this entity.
  - setCustomAnnotations
```
public void setCustomAnnotations(List<CustomAnnotation> customAnnotations)
```
  - getColumnConfigByColumnName
```
public Map<String,ColumnConfig> getColumnConfigByColumnName()
```
  - is
```
public boolean is(InheritanceType strategy)
```
  - useSearchResultConfig
```
public boolean useSearchResultConfig()
```
  - useSearchFieldConfig
```
public boolean useSearchFieldConfig()
```
  - useFormFieldConfig
```
public boolean useFormFieldConfig()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setLog
```
public void setLog(Log log)
```
  - setEntityName
```
public void setEntityName(String entityName)
```
  - setTableName
```
public void setTableName(String tableName)
```
  - setSequenceName
```
public void setSequenceName(String sequenceName)
```
  - setIndexed
```
public void setIndexed(Boolean indexed)
```
  - setMiddleTable
```
public void setMiddleTable(Boolean middleTable)
```
  - setComment
```
public void setComment(String comment)
```
  - setRootPackage
```
public void setRootPackage(String rootPackage)
```
  - setSubPackage
```
public void setSubPackage(String subPackage)
```
  - setLabel
```
public void setLabel(String label)
```
  - setAssociationDirection
```
public void setAssociationDirection(AssociationDirection associationDirection)
```
  - setCacheConfig
```
public void setCacheConfig(CacheConfig cacheConfig)
```
  - setInheritance
```
public void setInheritance(Inheritance inheritance)
```
  - setCollectionType
```
public void setCollectionType(CollectionType collectionType)
```
  - setExtendsClass
```
public void setExtendsClass(ExtendsClass extendsClass)
```
  - setImplementsInterfaces
```
public void setImplementsInterfaces(List<ImplementsInterface> implementsInterfaces)
```
  - setLabels
```
public void setLabels(List<Label> labels)
```
  - setMetaAttributes
```
public void setMetaAttributes(List<MetaAttribute> metaAttributes)
```
  - setColumnConfigByColumnName
```
public void setColumnConfigByColumnName(Map<String,ColumnConfig> columnConfigByColumnName)
```

Celerio API

Class EntityConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityConfig

Method Detail

getCacheConfig

getUsages

setUsages

forceUsagesToNullIfEmpty

forceImplementsInterfacesToNullIfEmpty

getEntityName

hasEntityName

getSequenceName

hasSequenceName

getTableName

hasTableName

getIndexed

hasTrueIndexed

getLabels

atLeastOneColumnConfigIsIndexed

getMiddleTable

hasMiddleTable

getComment

getCommentAsJavadoc

getCommentAsJavadoc

hasComment

getRootPackage

getSubPackage

getLabel

getAssociationDirection

getInheritance

hasInheritance

hasParentEntityName

getParentEntityName

getCollectionType

hasCollectionType

getExtendsClass

hasExtendsClass

getImplementsInterfaces

hasImplementsInterfaces

getMetaAttributes

getColumnConfigs

hasColumnConfigs

setColumnConfigs

addColumnConfig

getColumnConfigByColumnName

getColumnConfigByFieldName

getCustomAnnotations

setCustomAnnotations

getColumnConfigByColumnName

is

useSearchResultConfig

useSearchFieldConfig

useFormFieldConfig

toString

setLog

setEntityName

setTableName

setSequenceName

setIndexed

setMiddleTable

setComment

setRootPackage

setSubPackage

setLabel

setAssociationDirection

setCacheConfig

setInheritance

setCollectionType

setExtendsClass

setImplementsInterfaces

setLabels

setMetaAttributes

setColumnConfigByColumnName

Celerio API