sirius.db.mixing.properties

Class StringProperty

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.Composite

sirius.db.mixing.Property

sirius.db.mixing.properties.StringProperty

All Implemented Interfaces:

ESPropertyInfo, SQLPropertyInfo, sirius.kernel.di.transformers.Transformable

public class StringProperty
extends Property
implements SQLPropertyInfo, ESPropertyInfo

Represents an String field within a Mixable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringProperty.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

Method Summary

Modifier and Type	Method and Description
void	contributeToTable(Table table) Appends columns, keys and foreign keys to the given table to match the settings specified by this property
void	describeProperty(com.alibaba.fastjson.JSONObject description) Creates the mapping description for this property into the given JSON.
void	onBeforeSaveChecks(Object entity) Invoked before an entity is written to the database.
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
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, getValueFromField, hashCode, illegalFieldValue, isNullable, link, onAfterDelete, onAfterSave, onBeforeDelete, onBeforeSave, parseValue, setValue, toString, transformFromDatasource, 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

Method Detail

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

setValueFromDatasource

protected void setValueFromDatasource(Class<? extends BaseMapper<?,?,?>> mapperType,
                                      Object entity,
                                      sirius.kernel.commons.Value data)

Description copied from class: Property

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.

Overrides:

setValueFromDatasource 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.

entity - the entity to write to

data - the database value to store

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

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

onBeforeSaveChecks

public 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

contributeToTable

public void contributeToTable(Table table)

Description copied from interface: SQLPropertyInfo

Appends columns, keys and foreign keys to the given table to match the settings specified by this property

Specified by:

contributeToTable in interface SQLPropertyInfo

Parameters:

table - the table to add schema infos to

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