sirius.db.mixing.properties

Class StringListProperty

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.Composite

sirius.db.mixing.Property

sirius.db.mixing.properties.StringListProperty

All Implemented Interfaces:

ESPropertyInfo, sirius.kernel.di.transformers.Transformable

public class StringListProperty
extends Property
implements ESPropertyInfo

Represents a StringList field within a Mixable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringListProperty.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, mixing, oma

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

components

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StringListProperty(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.
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
protected Object	transformFromElastic(sirius.kernel.commons.Value object) Loads a value from an Elasticsearch database.
protected Object	transformFromMongo(sirius.kernel.commons.Value object) Loads a value from a MongoDB datasource.
protected Object	transformToElastic(Object object) Generates a value for an Elasticsearch database.
protected Object	transformToMongo(Object object) Generates a value for a MongoDB datasource.
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, transformFromJDBC, transformToDatasource, transformToJDBC

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

StringListProperty

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

Method Detail

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

transformToElastic

protected Object transformToElastic(Object object)

Description copied from class: Property

Generates a value for an Elasticsearch database.

Overrides:

transformToElastic in class Property

Parameters:

object - the database value

Returns:

the value which can be stored in the associated field

transformToMongo

protected Object transformToMongo(Object object)

Description copied from class: Property

Generates a value for a MongoDB datasource.

Overrides:

transformToMongo in class Property

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)

Description copied from class: Property

Loads a value from an Elasticsearch database.

Overrides:

transformFromElastic in class Property

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)

Description copied from class: Property

Loads a value from a MongoDB datasource.

Overrides:

transformFromMongo in class Property

Parameters:

object - the database value

Returns:

the value which can be stored in the associated field

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

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