sirius.db.mixing.properties

Class BaseEntityRefProperty<I,E extends BaseEntity<I>,R extends BaseEntityRef<I,E>>

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.Composite

sirius.db.mixing.Property

sirius.db.mixing.properties.BaseEntityRefProperty<I,E,R>

Type Parameters:

I - the type of the primary key

E - the type of entities being referenced

R - the type of the reference itself

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

Direct Known Subclasses:

ElasticRefProperty, MongoRefProperty, SQLEntityRefProperty

public abstract class BaseEntityRefProperty<I,E extends BaseEntity<I>,R extends BaseEntityRef<I,E>>
extends Property

Base implementation for handling properties of type BaseEntityRef.

Field Summary

Fields

Modifier and Type	Field and Description
protected R	entityRef
protected static Mixing	mixing
protected EntityDescriptor	referencedDescriptor
protected Class<? extends BaseEntity<?>>	referencedType

Fields inherited from class sirius.db.mixing.Property

accessPath, alternativePropertyKey, defaultValue, descriptor, field, label, length, name, nameAsMapping, nullable, propertyKey, propertyName

Fields inherited from class sirius.db.mixing.Mixable

elastic, mango, oma

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

components

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEntityRefProperty(EntityDescriptor descriptor, AccessPath accessPath, Field field)

Method Summary

Modifier and Type	Method and Description
protected abstract Optional<E>	find(Class<E> type, sirius.kernel.commons.Value value) Actually resolves the the type and value into an entity.
protected R	getEntityRef(Object entity)
EntityDescriptor	getReferencedDescriptor() Returns the EntityDescriptor of the referenced entity.
Class<? extends BaseEntity<?>>	getReferencedType() Returns the entity class of the referenced type.
protected Object	getValueFromField(Object target) Obtains the value from the field in the given target object
void	link() Links this property.
protected void	onBeforeSaveChecks(Object entity) Invoked before an entity is written to the database.
protected void	onDeleteCascade(Object e)
protected void	onDeleteReject(Object e)
protected void	onDeleteSetNull(Object e)
protected void	setValueToField(Object value, Object target) Applies the given value to the field in the given target object
protected Object	transformFromDatasource(Class<? extends BaseMapper<?,?,?>> mapperType, sirius.kernel.commons.Value object) Converts the database value to the appropriate field value.
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.
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.Property

checkNullability, checkUniqueness, determineDefaultValue, determineLengths, determineNullability, equals, getAnnotation, getDefaultValue, getDefinition, getDescriptor, getField, getLabel, getLength, getName, getPropertyName, getValue, getValueAsCopy, getValueForDatasource, hashCode, illegalFieldValue, isNullable, onAfterDelete, onAfterSave, onBeforeDelete, onBeforeSave, parseValue, setValue, setValueFromDatasource, toString, transformFromElastic, transformFromJDBC, transformFromMongo, transformToElastic, transformToJDBC, transformToMongo

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

mixing

protected static Mixing mixing

entityRef

protected R extends BaseEntityRef<I,E> entityRef

referencedType

protected Class<? extends BaseEntity<?>> referencedType

referencedDescriptor

protected EntityDescriptor referencedDescriptor

Constructor Detail

BaseEntityRefProperty

protected BaseEntityRefProperty(EntityDescriptor descriptor,
                                AccessPath accessPath,
                                Field field)

Method Detail

getReferencedType

public Class<? extends BaseEntity<?>> getReferencedType()

Returns the entity class of the referenced type.

Returns:

the class of the referenced entity

getReferencedDescriptor

public EntityDescriptor getReferencedDescriptor()

Returns the EntityDescriptor of the referenced entity.

Returns:

the referenced entity drescriptor

getValueFromField

protected Object getValueFromField(Object target)

Description copied from class: Property

Obtains the value from the field in the given target object

Overrides:

getValueFromField in class Property

Parameters:

target - the target object determined by the access path

Returns:

the object to be stored in the database

transformValue

public Object transformValue(sirius.kernel.commons.Value value)

Description copied from class: Property

Converts the given value, which most probably contains user input as string into the target type of this property.

Specified by:

transformValue in class Property

Parameters:

value - the value to convert

Returns:

the converted value

transformFromDatasource

protected Object transformFromDatasource(Class<? extends BaseMapper<?,?,?>> mapperType,
                                         sirius.kernel.commons.Value object)

Description copied from class: Property

Converts the database value to the appropriate field value.

Overrides:

transformFromDatasource in class Property

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

transformToDatasource

protected Object transformToDatasource(Class<? extends BaseMapper<?,?,?>> mapperType,
                                       Object object)

Description copied from class: Property

Converts the Java object which resides in the associated field to the database value which is to be written into the database.

Overrides:

transformToDatasource in class Property

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

find

protected abstract Optional<E> find(Class<E> type,
                                    sirius.kernel.commons.Value value)

Actually resolves the the type and value into an entity.

Parameters:

type - the type to resolve

value - the id to resolve

Returns:

the referenced entity wrapped as optional or an empty optional if no entity was found

getEntityRef

protected R getEntityRef(Object entity)

setValueToField

protected void setValueToField(Object value,
                               Object target)

Description copied from class: Property

Applies the given value to the field in the given target object

Overrides:

setValueToField in class Property

Parameters:

value - the database value to store

target - the target object determined by the access path

onBeforeSaveChecks

protected void onBeforeSaveChecks(Object entity)

Description copied from class: Property

Invoked before an entity is written to the database.

This method is intended to be overwritten with custom logic.

Overrides:

onBeforeSaveChecks in class Property

Parameters:

entity - the entity to check

link

public void link()

Description copied from class: Property

Links this property.

This is invoked once all EntityDescriptors are loaded and can be used to build references to other descriptors / properties.

Overrides:

link in class Property

onDeleteSetNull

protected void onDeleteSetNull(Object e)

onDeleteCascade

protected void onDeleteCascade(Object e)

onDeleteReject

protected void onDeleteReject(Object e)