EntityDescriptor (SIRIUS db 5.0-rc9 API)

java.lang.Object
- sirius.db.mixing.EntityDescriptor

```
public class EntityDescriptor
extends Object
```
Used by Mixing to describe all properties and consistency checks of a managed entity.
These entities and be stored and loaded from various databases using an appropriate mapper.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Consumer<Object>>`	`afterDeleteHandlers` A list of all additional handlers to be executed once an entity was successfully deleted
`protected List<Consumer<Object>>`	`afterSaveHandlers` A list of all additional handlers to be executed once an entity is was saved
`protected List<Consumer<Object>>`	`beforeDeleteHandlers` A list of all additional handlers to be executed once an entity is about to be deleted
`protected sirius.kernel.commons.PriorityCollector<Consumer<Object>>`	`beforeSaveHandlerCollector` Collects handlers which are executed before entity is saved, need to be in order (some checks might depend on others), `BeforeSave` permits to specify a property which is used to here to sort the handlers.
`protected List<Consumer<Object>>`	`cascadeDeleteHandlers` A list of all additional handlers to be executed once an entity was deleted
`protected Map<String,String>`	`columnAliases`
`protected Set<Class<? extends Composite>>`	`composites` Contains a set of all composites contained within this entity.
`protected static List<PropertyFactory>`	`factories` Contains all known property factories.
`protected com.typesafe.config.Config`	`legacyInfo`
`protected BaseMapper<?,?,?>`	`mapper`
`protected Set<Class<? extends Mixable>>`	`mixins` Contains a set of all mixins available for this entity.
`protected Map<String,Property>`	`properties` Contains all properties (defined via fields, composites or mixins)
`protected List<Consumer<Object>>`	`sortedBeforeSaveHandlers` A list of all additional handlers to be executed once an entity is about to be saved
`protected Class<?>`	`type` Contains the entity class
`protected List<BiConsumer<Object,Consumer<String>>>`	`validateHandlers` A list of all handlers to be executed once an entity is validated
`protected boolean`	`versioned`

Constructor Summary

Constructors
Modifier Constructor and Description

protected EntityDescriptor(Class<?> type)
Creates a new entity for the given reference instance.

Constructors
Modifier	Constructor and Description
`protected`	`EntityDescriptor(Class<?> type)` Creates a new entity for the given reference instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBeforeDeleteHandler(Consumer<Object> handler)` Adds a before delete handler for entities managed by this descriptor.
`void`	`addCascadeDeleteHandler(Consumer<Object> handler)` Adds a cascade handler for entities managed by this descriptor.
`void`	`addComposite(Class<? extends Composite> composite)` Used to add a class to the list of contained composites within the described entity.
`static void`	`addFields(EntityDescriptor descriptor, AccessPath accessPath, Class<?> clazz, Consumer<Property> propertyConsumer)`
`void`	`addValidationHandler(BiConsumer<Object,Consumer<String>> handler)` Adds a validation handler
`void`	`afterDelete(BaseEntity<?> entity)` Invokes all `afterDeleteHandlers`.
`void`	`afterSave(Object entity)` Executes all `afterSaveHandlers` once an entity was saved to the database.
`void`	`beforeDelete(Object entity)` Invokes all `beforeDeleteHandlers` and then all `cascadeDeleteHandlers` for the given entity.
`void`	`beforeSave(Object entity)` Executes all `beforedSaveHandlers` known to the descriptor.
`boolean`	`equals(Object obj)`
`Property`	`findProperty(String property)` Returns the property for the given name.
`String`	`getLabel()` Returns the "end user friendly" name of the entity.
`com.typesafe.config.Config`	`getLegacyInfo()` Provides access to the "legacy" block in the system config which is stored for this entity type.
`BaseMapper<?,?,?>`	`getMapper()` Returns the `mapper` in charge of managing entities of this type.
`Collection<Class<? extends Mixable>>`	`getMixins()` Returns all mixins known for the describes entity.
`String`	`getPluralLabel()` Returns the "end user friendly" plural of the entity.
`Collection<Property>`	`getProperties()` Returns all properties known by this descriptor.
`Property`	`getProperty(Mapping column)` Returns the property for the given column.
`Property`	`getProperty(String property)` Returns the property for the given name.
`String`	`getRealm()` Returns the realm of entities of this type.
`Object`	`getReferenceInstance()` Each descriptor keeps a single instance of the entity as reference to determine default values etc.
`String`	`getRelationName()` Returns the technical simple name to use.
`Class<?>`	`getType()` Returns the entity class managed by this descriptor.
`boolean`	`hasComposite(Class<? extends Composite> composite)` Determines if a composite of the given type is present within this entity.
`int`	`hashCode()`
`boolean`	`hasValidationWarnings(Object entity)` Determines if the given entity has validation warnings.
`protected void`	`initialize()` Loads all properties from the fields being present in the target type.
`boolean`	`isChanged(BaseEntity<?> entity, Property property)` Determines if the value for the property was changed since it was last fetched from the database.
`boolean`	`isFetched(BaseEntity<?> entity, Property property)` Determines if a value was fetched in the given entity for the given property.
`boolean`	`isVersioned()` Determines if the underlying entity uses optimistic locking.
`protected void`	`link()` Links all properties to setup foreign keys and delete constraints.
`Object`	`make(Class<? extends BaseMapper<?,?,?>> mapperType, String alias, sirius.kernel.commons.ValueSupplier<String> supplier)` Creates an entity from the given result row.
`String`	`rewritePropertyName(String basicPropertyName)` Applies legacy renaming rules to determine the effective property name based on the name generated by the property.
`String`	`toString()`
`List<String>`	`validate(Object entity)` Executes all validation handlers on the given entity.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - type
```
protected final Class<?> type
```
    Contains the entity class
  - properties
```
protected final Map<String,Property> properties
```
    Contains all properties (defined via fields, composites or mixins)
  - composites
```
protected final Set<Class<? extends Composite>> composites
```
    Contains a set of all composites contained within this entity.
  - mixins
```
protected final Set<Class<? extends Mixable>> mixins
```
    Contains a set of all mixins available for this entity.
  - cascadeDeleteHandlers
```
protected final List<Consumer<Object>> cascadeDeleteHandlers
```
    A list of all additional handlers to be executed once an entity was deleted
  - beforeDeleteHandlers
```
protected final List<Consumer<Object>> beforeDeleteHandlers
```
    A list of all additional handlers to be executed once an entity is about to be deleted
  - afterDeleteHandlers
```
protected final List<Consumer<Object>> afterDeleteHandlers
```
    A list of all additional handlers to be executed once an entity was successfully deleted
  - sortedBeforeSaveHandlers
```
protected List<Consumer<Object>> sortedBeforeSaveHandlers
```
    A list of all additional handlers to be executed once an entity is about to be saved
  - beforeSaveHandlerCollector
```
protected sirius.kernel.commons.PriorityCollector<Consumer<Object>> beforeSaveHandlerCollector
```
    Collects handlers which are executed before entity is saved, need to be in order (some checks might depend on others), BeforeSave permits to specify a property which is used to here to sort the handlers. sortedBeforeSaveHandlers will be filled when first accessed and provide a properly sorted list
  - afterSaveHandlers
```
protected final List<Consumer<Object>> afterSaveHandlers
```
    A list of all additional handlers to be executed once an entity is was saved
  - validateHandlers
```
protected final List<BiConsumer<Object,Consumer<String>>> validateHandlers
```
    A list of all handlers to be executed once an entity is validated
  - factories
```
protected static List<PropertyFactory> factories
```
    Contains all known property factories. These are used to transform fields defined by entity classes to properties
  - legacyInfo
```
protected com.typesafe.config.Config legacyInfo
```
  - columnAliases
```
protected Map<String,String> columnAliases
```
  - versioned
```
protected boolean versioned
```
  - mapper
```
protected BaseMapper<?,?,?> mapper
```
- Constructor Detail
  - EntityDescriptor
```
protected EntityDescriptor(Class<?> type)
```
    Creates a new entity for the given reference instance.
    
    Parameters:
    
    type - the type from which the descriptor is filled
- Method Detail
  - getRelationName
```
public String getRelationName()
```
    Returns the technical simple name to use.
    This is e.g. used to determine table names or collection names in the datasource.
    
    Returns:
    
    the technical name to use.
  - getRealm
```
public String getRealm()
```
    Returns the realm of entities of this type.
    Depending on the mapper and database, this can control the effective target database or storage settings used for this entity.
    
    Returns:
    
    the realm of this type
  - getLabel
```
public String getLabel()
```
    Returns the "end user friendly" name of the entity.
    This is determined by calling NLS.get() with the full class name or as fallback the simple class name as lower case, prepended with "Model.". Therefore the property keys for "org.acme.model.Customer" would be the class name and "Model.customer". The fallback key will be the same which is tried for a property named "customer" and can therefore be reused.
    
    Returns:
    
    a translated name which can be shown to the end user
  - getPluralLabel
```
public String getPluralLabel()
```
    Returns the "end user friendly" plural of the entity.
    The i18n keys tried are the same as for getLabel() with ".plural" appended.
    
    Returns:
    
    a translated plural which can be shown to the end user
  - link
```
protected void link()
```
    Links all properties to setup foreign keys and delete constraints.
  - getProperties
```
public Collection<Property> getProperties()
```
    Returns all properties known by this descriptor.
    These are either properties declared by the type (class) of the entity and its superclasses or once defined by Composites and Mixins.
    
    Returns:
    
    a list of all properties of the entity
  - isFetched
```
public boolean isFetched(BaseEntity<?> entity,
                         Property property)
```
    Determines if a value was fetched in the given entity for the given property.
    As queries might select only certain fields, not all properties are filled for an entity.
    
    Parameters:
    
    entity - the entity to check
    
    property - the property to check for
    
    Returns:
    
    true if a value was fetched from the database, false otherwise
  - isChanged
```
public boolean isChanged(BaseEntity<?> entity,
                         Property property)
```
    Determines if the value for the property was changed since it was last fetched from the database.
    
    Parameters:
    
    entity - the entity to check
    
    property - the property to check for
    
    Returns:
    
    true if the value was changed, false otherwise
  - beforeSave
```
public final void beforeSave(Object entity)
```
    Executes all beforedSaveHandlers known to the descriptor.
    
    Parameters:
    
    entity - the entity to perform the handlers on
  - afterSave
```
public void afterSave(Object entity)
```
    Executes all afterSaveHandlers once an entity was saved to the database.
    
    Parameters:
    
    entity - the entity which was saved
  - validate
```
public List<String> validate(Object entity)
```
    Executes all validation handlers on the given entity.
    
    Parameters:
    
    entity - the entity to validate
    
    Returns:
    
    a list of all validation warnings
  - hasValidationWarnings
```
public boolean hasValidationWarnings(Object entity)
```
    Determines if the given entity has validation warnings.
    
    Parameters:
    
    entity - the entity to check
    
    Returns:
    
    true if there are validation warnings, false otherwise
  - beforeDelete
```
public void beforeDelete(Object entity)
```
    Invokes all beforeDeleteHandlers and then all cascadeDeleteHandlers for the given entity.
    
    Parameters:
    
    entity - the entity which is about to be deleted
  - addCascadeDeleteHandler
```
public void addCascadeDeleteHandler(Consumer<Object> handler)
```
    Adds a cascade handler for entities managed by this descriptor.
    
    Parameters:
    
    handler - the handler to add
  - addBeforeDeleteHandler
```
public void addBeforeDeleteHandler(Consumer<Object> handler)
```
    Adds a before delete handler for entities managed by this descriptor.
    
    Parameters:
    
    handler - the handler to add
  - addValidationHandler
```
public void addValidationHandler(BiConsumer<Object,Consumer<String>> handler)
```
    Adds a validation handler
    
    Parameters:
    
    handler - the handler to add
  - afterDelete
```
public void afterDelete(BaseEntity<?> entity)
```
    Invokes all afterDeleteHandlers.
    
    Parameters:
    
    entity - the entity which was deleted
  - initialize
```
protected void initialize()
```
    Loads all properties from the fields being present in the target type.
  - addFields
```
public static void addFields(EntityDescriptor descriptor,
                             AccessPath accessPath,
                             Class<?> clazz,
                             Consumer<Property> propertyConsumer)
```
  - make
```
public Object make(Class<? extends BaseMapper<?,?,?>> mapperType,
                   String alias,
                   sirius.kernel.commons.ValueSupplier<String> supplier)
            throws Exception
```
    Creates an entity from the given result row.
    
    Parameters:
    
    mapperType - the mapper which is currently active
    
    alias - the field alias used to generate unique column names
    
    supplier - used to provide values for a given column name
    
    Returns:
    
    an entity containing the values of the given result row
    
    Throws:
    
    Exception - in case of an error while building the entity
  - rewritePropertyName
```
public String rewritePropertyName(String basicPropertyName)
```
    Applies legacy renaming rules to determine the effective property name based on the name generated by the property.
    
    Parameters:
    
    basicPropertyName - the generic property name generated by the property
    
    Returns:
    
    the (optionally) rewritten property name to match legacy schemas
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getType
```
public Class<?> getType()
```
    Returns the entity class managed by this descriptor.
    
    Returns:
    
    the entity class
  - getProperty
```
public Property getProperty(Mapping column)
```
    Returns the property for the given column.
    
    Parameters:
    
    column - the name of the property given as column
    
    Returns:
    
    the property which belongs to the given column
  - getProperty
```
@Nonnull
public Property getProperty(String property)
```
    Returns the property for the given name.
    If the property does not exits, an error will be thrown.
    
    Parameters:
    
    property - the name of the property
    
    Returns:
    
    the property with the given name
  - findProperty
```
@Nullable
public Property findProperty(String property)
```
    Returns the property for the given name.
    If the property does not exist, null is returned.
    
    Parameters:
    
    property - the name of the property or null if no property with the given name exists.
    
    Returns:
    
    the property with the given name
  - getReferenceInstance
```
public Object getReferenceInstance()
```
    Each descriptor keeps a single instance of the entity as reference to determine default values etc.
    
    Returns:
    
    the default instance
  - getMapper
```
public BaseMapper<?,?,?> getMapper()
```
    Returns the mapper in charge of managing entities of this type.
    
    Returns:
    
    the mapper responsible for entities of this descriptor
  - addComposite
```
public void addComposite(Class<? extends Composite> composite)
```
    Used to add a class to the list of contained composites within the described entity.
    This is used by CompositePropertyFactory to notify the descriptor that a composite is present.
    
    Parameters:
    
    composite - the type of composite which is present within this entity
  - hasComposite
```
public boolean hasComposite(Class<? extends Composite> composite)
```
    Determines if a composite of the given type is present within this entity.
    
    Parameters:
    
    composite - the composite type to check for
    
    Returns:
    
    true if one or more composites of the given type are present, false otherwise
  - getMixins
```
public Collection<Class<? extends Mixable>> getMixins()
```
    Returns all mixins known for the describes entity.
    
    Returns:
    
    a collection containing all mixin classes affecting the described entity
  - getLegacyInfo
```
public com.typesafe.config.Config getLegacyInfo()
```
    Provides access to the "legacy" block in the system config which is stored for this entity type.
    
    Returns:
    
    the legacy settings in the system config
  - isVersioned
```
public boolean isVersioned()
```
    Determines if the underlying entity uses optimistic locking.
    
    Returns:
    
    true if version based optimistic locking is used, false otherwise

Class EntityDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

properties

composites

mixins

cascadeDeleteHandlers

beforeDeleteHandlers

afterDeleteHandlers

sortedBeforeSaveHandlers

beforeSaveHandlerCollector

afterSaveHandlers

validateHandlers

factories

legacyInfo

columnAliases

versioned

mapper

Constructor Detail

EntityDescriptor

Method Detail

getRelationName

getRealm

getLabel

getPluralLabel

link

getProperties

isFetched

isChanged

beforeSave

afterSave

validate

hasValidationWarnings

beforeDelete

addCascadeDeleteHandler

addBeforeDeleteHandler

addValidationHandler

afterDelete

initialize

addFields

make

rewritePropertyName

toString

equals

hashCode

getType

getProperty

getProperty

findProperty

getReferenceInstance

getMapper

addComposite

hasComposite

getMixins

getLegacyInfo

isVersioned