sirius.db.mixing.properties

Class BaseMapProperty

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.Composite

sirius.db.mixing.Property

sirius.db.mixing.properties.BaseMapProperty

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

Direct Known Subclasses:

StringIntMapProperty, StringLocalDateTimeMapProperty, StringMapProperty, StringNestedMapProperty

public abstract class BaseMapProperty
extends Property

Represents a SafeMap field within a Mixable.

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, mixing, oma

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

components

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected SafeMap<?,?>	getMap(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	setValueToField(Object value, Object target) Applies the given value to the field in the given target object
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, onBeforeSaveChecks, parseValue, setValue, setValueFromDatasource, toString, transformFromDatasource, transformFromElastic, transformFromJDBC, transformFromMongo, transformToDatasource, 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

Constructor Detail

BaseMapProperty

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

Method Detail

getMap

protected SafeMap<?,?> getMap(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