sirius.db.mixing.properties

Class StringMapProperty

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

sirius.db.mixing.properties.StringMapProperty

All Implemented Interfaces:

ESPropertyInfo, sirius.kernel.di.transformers.Transformable

Direct Known Subclasses:

StringListMapProperty

public class StringMapProperty
extends BaseMapProperty
implements ESPropertyInfo

Represents an StringMap field within an ElasticEntity or a MongoEntity.

Note that maps are stored as a list of nested objects which contain a key and a value. This is used to prevent a mapping explosion within ES while still permitting to search and filter using nested queries. Use IndexMode.indexed() (set to FALSE) to set the type to object - which will still create key/value pairs but stored as objects.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY Contains the name of the field used to store the map key
static String	VALUE Contains the name of the field used to store the map value

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	describeProperty(com.alibaba.fastjson.JSONObject description) Creates the mapping description for this property into the given JSON.
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.

Methods inherited from class sirius.db.mixing.properties.BaseMapProperty

getMap, getValueAsCopy, getValueFromField, setValueToField, transformValue

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

Field Detail

KEY

public static final String KEY

Contains the name of the field used to store the map key

See Also:

Constant Field Values

VALUE

public static final String VALUE

Contains the name of the field used to store the map value

See Also:

Constant Field Values

Method Detail

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

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

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