sirius.db.mixing.properties

Class NestedListProperty

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.Composite

sirius.db.mixing.Property

sirius.db.mixing.properties.NestedListProperty

All Implemented Interfaces:

ESPropertyInfo, sirius.kernel.di.transformers.Transformable

public class NestedListProperty
extends Property
implements ESPropertyInfo

Represents an NestedList field within a MongoEntity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NestedListProperty.Factory Factory for generating properties based on their field type

Field Summary

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	NestedListProperty(EntityDescriptor descriptor, AccessPath accessPath, Field field)

Method Summary

Modifier and Type	Method and Description
void	describeProperty(com.alibaba.fastjson.JSONObject description) Creates the mapping description for this property into the given JSON.
protected EntityDescriptor	getNestedDescriptor()
protected NestedList<?>	getNestedList(Object 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.
protected Object	getValueFromField(Object target) Obtains the value from the field in the given target object
protected void	onBeforeSaveChecks(Object entity) Invoked before an entity is written to the database.
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, getValueForDatasource, hashCode, illegalFieldValue, isNullable, link, 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

Methods inherited from interface sirius.db.es.ESPropertyInfo

transferOption

Constructor Detail

NestedListProperty

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

Method Detail

getNestedList

protected NestedList<?> getNestedList(Object entity)

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

getValueAsCopy

public Object getValueAsCopy(Object entity)

Description copied from class: Property

For modifyable datatypes like collections, this returns the value as copy so that further modifications will not change the returned value.

Overrides:

getValueAsCopy in class Property

Parameters:

entity - the entity to fetch the value from

Returns:

the as compy of the value which is currently stored in the field

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

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

getNestedDescriptor

protected EntityDescriptor getNestedDescriptor()

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

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

describeProperty

public void describeProperty(com.alibaba.fastjson.JSONObject description)

Description copied from interface: ESPropertyInfo

Creates the mapping description for this property into the given JSON.

Specified by:

describeProperty in interface ESPropertyInfo

Parameters:

description - the target JSON to fill