Property (SIRIUS db 5.0-rc9 API)

java.lang.Object
- sirius.kernel.di.transformers.Composable
- - sirius.db.mixing.Mixable
  - - sirius.db.mixing.Composite
    - - sirius.db.mixing.Property

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

Direct Known Subclasses:

AmountProperty, BaseEntityRefListProperty, BaseEntityRefProperty, BaseMapProperty, BooleanProperty, EnumProperty, InstantProperty, IntegerProperty, LocalDateProperty, LocalDateTimeProperty, LocalTimeProperty, LongProperty, MultiPointLocationProperty, NestedListProperty, StringListProperty, StringProperty
```
public abstract class Property
extends Composite
```
Maps a field, which is either defined in an entity, a composite or a mixin to a mapped property.
A property is responsible for mapping (converting) a value between a field (Field and a database column. It is also responsible for checking the consistency of this field.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccessPath`	`accessPath` Contains the access path used to obtain the target object containing the field
`protected String`	`alternativePropertyKey` Contains the alternative i18n key used to determine the label (official name) of the property.
`protected String`	`defaultValue` Contains a string representation of the default value for the column
`protected EntityDescriptor`	`descriptor` Contains the descriptor to which this property belongs
`protected Field`	`field` The field which generated the property (which stores the column value in the Java world)
`protected String`	`label` Contains a used defined name.
`protected int`	`length` Contains the length of this property
`protected String`	`name` Contains the effective property name.
`protected Mapping`	`nameAsMapping` Represents the name of the property a `Mapping`
`protected boolean`	`nullable` Determines the nullability of the property
`protected String`	`propertyKey` Contains the i18n key used to determine the label (official name) of the property.
`protected String`	`propertyName` Contains the effective property name.

Fields inherited from class sirius.db.mixing.Mixable
elastic, mango, mixing, oma

Fields inherited from class sirius.kernel.di.transformers.Composable
components

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Property(EntityDescriptor descriptor, AccessPath accessPath, Field field)` Creates a new property for the given descriptor, access path and field.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkNullability(Object propertyValue)` Checks if the value is non-null or the property accepts null values.
`protected void`	`checkUniqueness(Object entity, Object propertyValue)` Checks the uniqueness of the given value and entity if an `Unique` annotation is present
`protected void`	`determineDefaultValue()` Determines the default value of the column by checking for a `DefaultValue` annotation on the field.
`protected void`	`determineLengths()` Determines the column length by checking for a `Length` annotation on the field.
`protected void`	`determineNullability()` Determines the nullability of the column by checking for a `NullAllowed` annotation on the field.
`boolean`	`equals(Object obj)`
`<A extends Annotation> Optional<A>`	`getAnnotation(Class<A> type)` Returns the anotation of the given type.
`String`	`getDefaultValue()` Returns the default value to use.
`protected String`	`getDefinition()` Returns the class name and field name which "defined" this property.
`EntityDescriptor`	`getDescriptor()` Returns the entity descriptor to which this property belongs
`protected Field`	`getField()` Returns the field which will store the database value
`String`	`getLabel()` Returns the name of the property which is shown to the user.
`int`	`getLength()` Returns the length of the generated column.
`String`	`getName()` Returns the name of the property.
`String`	`getPropertyName()` Returns the effective property name.
`Object`	`getValue(Object entity)` Obtains the field value from the given entity.
`Object`	`getValueAsCopy(Object entity)` For modifyable datatypes like collections, this returns the value as copy so that further modifications will not change the returned value.
`Object`	`getValueForDatasource(Class<? extends BaseMapper<?,?,?>> mapperType, Object entity)` Obtains the database value from the given entity.
`protected Object`	`getValueFromField(Object target)` Obtains the value from the field in the given target object
`int`	`hashCode()`
`protected sirius.kernel.health.HandledException`	`illegalFieldValue(sirius.kernel.commons.Value value)` Creates an exception which represents an illegal value for this property
`boolean`	`isNullable()` Determines if this property accepts null values
`protected void`	`link()` Links this property.
`protected void`	`onAfterDelete(Object entity)` Invoked after an entity was deleted from the database
`protected void`	`onAfterSave(Object entity)` Invoked after an entity was written to the database
`protected void`	`onBeforeDelete(Object entity)` Invoked before an entity is deleted from the database
`protected void`	`onBeforeSave(Object entity)` Invoked before an entity is written to the database.
`protected void`	`onBeforeSaveChecks(Object entity)` Invoked before an entity is written to the database.
`void`	`parseValue(Object e, sirius.kernel.commons.Value value)` Parses the given value and applies it to the given entity if possible.
`protected void`	`setValue(Object entity, Object object)` Applies the given value to the given entity.
`protected void`	`setValueFromDatasource(Class<? extends BaseMapper<?,?,?>> mapperType, Object entity, sirius.kernel.commons.Value data)` Applies the given database value to the given entity.
`protected void`	`setValueToField(Object value, Object target)` Applies the given value to the field in the given target object
`String`	`toString()`
`protected Object`	`transformFromDatasource(Class<? extends BaseMapper<?,?,?>> mapperType, sirius.kernel.commons.Value object)` Converts the database value to the appropriate field value.
`protected Object`	`transformFromElastic(sirius.kernel.commons.Value object)` Loads a value from an Elasticsearch database.
`protected Object`	`transformFromJDBC(sirius.kernel.commons.Value object)` Loads a value from a JDBC datasource.
`protected Object`	`transformFromMongo(sirius.kernel.commons.Value object)` Loads a value from a MongoDB datasource.
`protected Object`	`transformToDatasource(Class<? extends BaseMapper<?,?,?>> mapperType, Object object)` Converts the Java object which resides in the associated field to the database value which is to be written into the database.
`protected Object`	`transformToElastic(Object object)` Generates a value for an Elasticsearch database.
`protected Object`	`transformToJDBC(Object object)` Generates a value for a JDBC datasource.
`protected Object`	`transformToMongo(Object object)` Generates a value for a MongoDB datasource.
`abstract Object`	`transformValue(sirius.kernel.commons.Value value)` Converts the given value, which most probably contains user input as string into the target type of this property.

Methods inherited from class sirius.db.mixing.Mixable
is, makeNewInstance, tryAs

Methods inherited from class sirius.kernel.di.transformers.Composable
as, attach, attach

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

- Field Detail
  - name
```
protected String name
```
    Contains the effective property name. If the field, for which this property was created, resides inside a mixin or composite, the name will be prefixed appropriately. Names are separated by Mapping.SUBFIELD_SEPARATOR which is a _.
  - propertyName
```
protected String propertyName
```
    Contains the effective property name. This is normally the same as name but can be re-written to support legacy table and column names.
  - nameAsMapping
```
protected Mapping nameAsMapping
```
    Represents the name of the property a Mapping
  - label
```
protected String label
```
    Contains a used defined name. This is intended to overwrite property names in customizations.
    
    See Also:
    
    getLabel()
  - propertyKey
```
protected String propertyKey
```
    Contains the i18n key used to determine the label (official name) of the property.
    
    See Also:
    
    getLabel()
  - alternativePropertyKey
```
protected String alternativePropertyKey
```
    Contains the alternative i18n key used to determine the label (official name) of the property.
    
    See Also:
    
    getLabel()
  - descriptor
```
protected EntityDescriptor descriptor
```
    Contains the descriptor to which this property belongs
  - accessPath
```
protected AccessPath accessPath
```
    Contains the access path used to obtain the target object containing the field
  - field
```
protected Field field
```
    The field which generated the property (which stores the column value in the Java world)
  - defaultValue
```
protected String defaultValue
```
    Contains a string representation of the default value for the column
  - length
```
protected int length
```
    Contains the length of this property
  - nullable
```
protected boolean nullable
```
    Determines the nullability of the property
- Constructor Detail
  - Property
```
protected Property(@Nonnull
                   EntityDescriptor descriptor,
                   @Nonnull
                   AccessPath accessPath,
                   @Nonnull
                   Field field)
```
    Creates a new property for the given descriptor, access path and field.
    
    Parameters:
    
    descriptor - the descriptor which owns the property
    
    accessPath - the access path required to obtain the target object which contains the field
    
    field - the field which stores the database value
- Method Detail
  - determineDefaultValue
```
protected void determineDefaultValue()
```
    Determines the default value of the column by checking for a DefaultValue annotation on the field.
  - determineLengths
```
protected void determineLengths()
```
    Determines the column length by checking for a Length annotation on the field.
  - determineNullability
```
protected void determineNullability()
```
    Determines the nullability of the column by checking for a NullAllowed annotation on the field.
    Note that subclasses might overwrite this value if they do not accept null values (like properties for primitive types).
  - getAnnotation
```
public <A extends Annotation> Optional<A> getAnnotation(Class<A> type)
```
    Returns the anotation of the given type.
    
    Type Parameters:
    
    A - the annotation to fetch
    
    Parameters:
    
    type - the type of the annotation to fetch
    
    Returns:
    
    the annotation as optional or null, if the field defining the property doesn't wear an annotation of the given type
  - getName
```
public String getName()
```
    Returns the name of the property.
    
    Returns:
    
    the name of the property.
  - getPropertyName
```
public String getPropertyName()
```
    Returns the effective property name.
    
    Returns:
    
    the name of the property in the database
  - getField
```
@Nonnull
protected Field getField()
```
    Returns the field which will store the database value
    
    Returns:
    
    the field in the target object which stores the database value
  - getLabel
```
public String getLabel()
```
    Returns the name of the property which is shown to the user.
    This can be used in error messages or for labelling in forms.
    The label can be set in three ways:
    1. Define an i18n value for propertyKey, which is normally [declaingClass].[field]. So for com.acme.model.Customer.customerNumber this would be Customer.customerNumber
    2. Define an i18n value for alternativePropertyKey, which is normally Model.[field]. So for com.acme.model.Customer.customerNumber this would be Model.customerNumber. That way common names across different entites can share the same translation.
    Returns:
    
    the effective label of the property.
  - getDefinition
```
protected String getDefinition()
```
    Returns the class name and field name which "defined" this property.
    This is mainly used to report errors for duplicate names etc.
    
    Returns:
    
    the "qualified" field name which "defined" this property
  - setValue
```
protected void setValue(Object entity,
                        Object object)
```
    Applies the given value to the given entity.
    The internal access path will be used to find the target object which contains the field.
    
    Parameters:
    
    entity - the entity to write to
    
    object - the value to write to the field
  - setValueToField
```
protected void setValueToField(Object value,
                               Object target)
```
    Applies the given value to the field in the given target object
    
    Parameters:
    
    value - the database value to store
    
    target - the target object determined by the access path
  - setValueFromDatasource
```
protected void setValueFromDatasource(Class<? extends BaseMapper<?,?,?>> mapperType,
                                      Object entity,
                                      sirius.kernel.commons.Value data)
```
    Applies the given database value to the given entity.
    The internal access path will be used to find the target object which contains the field.
    If the underlying field of this property is primitive, but the given value is null or transformed to null, this will be ignored. An scenario like this might happen, if we join-fetch a value, which is not present.
    
    Parameters:
    
    mapperType - the mapper which is currently active. This can be used to determine which kind of database is active and therefore which data format will be available.
    
    entity - the entity to write to
    
    data - the database value to store
  - transformFromDatasource
```
protected Object transformFromDatasource(Class<? extends BaseMapper<?,?,?>> mapperType,
                                         sirius.kernel.commons.Value object)
```
    Converts the database value to the appropriate field value.
    
    Parameters:
    
    mapperType - the mapper which is currently active. This can be used to determine which kind of database is active and therefore which data format will be available.
    
    object - the database value
    
    Returns:
    
    the value which can be stored in the associated field
  - transformFromJDBC
```
protected Object transformFromJDBC(sirius.kernel.commons.Value object)
```
    Loads a value from a JDBC datasource.
    
    Parameters:
    
    object - the database value
    
    Returns:
    
    the value which can be stored in the associated field
  - transformFromElastic
```
protected Object transformFromElastic(sirius.kernel.commons.Value object)
```
    Loads a value from an Elasticsearch database.
    
    Parameters:
    
    object - the database value
    
    Returns:
    
    the value which can be stored in the associated field
  - transformFromMongo
```
protected Object transformFromMongo(sirius.kernel.commons.Value object)
```
    Loads a value from a MongoDB datasource.
    
    Parameters:
    
    object - the database value
    
    Returns:
    
    the value which can be stored in the associated field
  - getValue
```
public Object getValue(Object entity)
```
    Obtains the field value from the given entity.
    The internal access path will be used to find the target object which contains the field.
    
    Parameters:
    
    entity - the entity to fetch the value from
    
    Returns:
    
    the value which is currently stored in the field
  - getValueAsCopy
```
public Object getValueAsCopy(Object entity)
```
    For modifyable datatypes like collections, this returns the value as copy so that further modifications will not change the returned value.
    
    Parameters:
    
    entity - the entity to fetch the value from
    
    Returns:
    
    the as compy of the value which is currently stored in the field
  - getValueFromField
```
protected Object getValueFromField(Object target)
```
    Obtains the value from the field in the given target object
    
    Parameters:
    
    target - the target object determined by the access path
    
    Returns:
    
    the object to be stored in the database
  - getValueForDatasource
```
public Object getValueForDatasource(Class<? extends BaseMapper<?,?,?>> mapperType,
                                    Object entity)
```
    Obtains the database value from the given entity.
    The internal access path will be used to find the target object which contains the field.
    
    Parameters:
    
    mapperType - the mapper which is currently active. This can be used to determine which kind of database is active and therefore which data format will be required.
    
    entity - the entity to write to
    
    Returns:
    
    the database value to store in the db
  - transformToDatasource
```
protected Object transformToDatasource(Class<? extends BaseMapper<?,?,?>> mapperType,
                                       Object object)
```
    Converts the Java object which resides in the associated field to the database value which is to be written into the database.
    
    Parameters:
    
    mapperType - the mapper which is currently active. This can be used to determine which kind of database is active and therefore which data format will be required.
    
    object - the current field value
    
    Returns:
    
    the value which is to be written to the database
  - transformToJDBC
```
protected Object transformToJDBC(Object object)
```
    Generates a value for a JDBC datasource.
    
    Parameters:
    
    object - the database value
    
    Returns:
    
    the value which can be stored in the associated field
  - transformToElastic
```
protected Object transformToElastic(Object object)
```
    Generates a value for an Elasticsearch database.
    
    Parameters:
    
    object - the database value
    
    Returns:
    
    the value which can be stored in the associated field
  - transformToMongo
```
protected Object transformToMongo(Object object)
```
    Generates a value for a MongoDB datasource.
    
    Parameters:
    
    object - the database value
    
    Returns:
    
    the value which can be stored in the associated field
  - parseValue
```
public void parseValue(Object e,
                       sirius.kernel.commons.Value value)
```
    Parses the given value and applies it to the given entity if possible.
    
    Parameters:
    
    e - the entity to receive the parsed value
    
    value - the value to parse and apply
  - transformValue
```
public abstract Object transformValue(sirius.kernel.commons.Value value)
```
    Converts the given value, which most probably contains user input as string into the target type of this property.
    
    Parameters:
    
    value - the value to convert
    
    Returns:
    
    the converted value
  - illegalFieldValue
```
protected sirius.kernel.health.HandledException illegalFieldValue(sirius.kernel.commons.Value value)
```
    Creates an exception which represents an illegal value for this property
    
    Parameters:
    
    value - the illegal value itself
    
    Returns:
    
    an exception filled with an appropriate message
  - getDescriptor
```
public EntityDescriptor getDescriptor()
```
    Returns the entity descriptor to which this property belongs
    
    Returns:
    
    the descriptor which owns this propery
  - onBeforeSave
```
protected final void onBeforeSave(Object entity)
```
    Invoked before an entity is written to the database.
    Checks the nullability and uniqueness of the property.
    
    Parameters:
    
    entity - the entity to check
  - onBeforeSaveChecks
```
protected void onBeforeSaveChecks(Object entity)
```
    Invoked before an entity is written to the database.
    This method is intended to be overwritten with custom logic.
    
    Parameters:
    
    entity - the entity to check
  - checkNullability
```
protected void checkNullability(Object propertyValue)
```
    Checks if the value is non-null or the property accepts null values.
    
    Parameters:
    
    propertyValue - the value to check
  - checkUniqueness
```
protected void checkUniqueness(Object entity,
                               Object propertyValue)
```
    Checks the uniqueness of the given value and entity if an Unique annotation is present
    
    Parameters:
    
    entity - the entity to check
    
    propertyValue - the value to check
  - onAfterSave
```
protected void onAfterSave(Object entity)
```
    Invoked after an entity was written to the database
    
    Parameters:
    
    entity - the entity which was written to the database
  - onBeforeDelete
```
protected void onBeforeDelete(Object entity)
```
    Invoked before an entity is deleted from the database
    
    Parameters:
    
    entity - the entity to be deleted
  - onAfterDelete
```
protected void onAfterDelete(Object entity)
```
    Invoked after an entity was deleted from the database
    
    Parameters:
    
    entity - the entity which was deleted
  - link
```
protected void link()
```
    Links this property.
    This is invoked once all EntityDescriptors are loaded and can be used to build references to other descriptors / properties.
  - isNullable
```
public boolean isNullable()
```
    Determines if this property accepts null values
    
    Returns:
    
    true if this property accepts null values, false otherwise
  - getLength
```
public int getLength()
```
    Returns the length of the generated column.
    
    Returns:
    
    the length of the column or 0 if the associated column has no length
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns the default value to use.
    
    Returns:
    
    the default value of this property
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Property

Field Summary

Fields inherited from class sirius.db.mixing.Mixable

Fields inherited from class sirius.kernel.di.transformers.Composable

Constructor Summary

Method Summary

Methods inherited from class sirius.db.mixing.Mixable

Methods inherited from class sirius.kernel.di.transformers.Composable

Methods inherited from class java.lang.Object

Field Detail

name

propertyName

nameAsMapping

label

propertyKey

alternativePropertyKey

descriptor

accessPath

field

defaultValue

length

nullable

Constructor Detail

Property

Method Detail

determineDefaultValue

determineLengths

determineNullability

getAnnotation

getName

getPropertyName

getField

getLabel

getDefinition

setValue

setValueToField

setValueFromDatasource

transformFromDatasource

transformFromJDBC

transformFromElastic

transformFromMongo

getValue

getValueAsCopy

getValueFromField

getValueForDatasource

transformToDatasource

transformToJDBC

transformToElastic

transformToMongo

parseValue

transformValue

illegalFieldValue

getDescriptor

onBeforeSave

onBeforeSaveChecks

checkNullability

checkUniqueness

onAfterSave

onBeforeDelete

onAfterDelete

link

isNullable

getLength

getDefaultValue

equals

hashCode

toString