sirius.db.mixing.properties

Class ElasticRefProperty

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.Composite

sirius.db.mixing.Property

sirius.db.mixing.properties.BaseEntityRefProperty<String,ElasticEntity,ElasticRef<ElasticEntity>>

sirius.db.mixing.properties.ElasticRefProperty

All Implemented Interfaces:

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

public class ElasticRefProperty
extends BaseEntityRefProperty<String,ElasticEntity,ElasticRef<ElasticEntity>>
implements SQLPropertyInfo, ESPropertyInfo

Represents a reference to another ElasticEntity field within a Mixable.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class sirius.db.mixing.properties.BaseEntityRefProperty

entityRef, mixing, referencedDescriptor, referencedType

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

mango, oma

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

components

Constructor Summary

Constructors

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

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.
protected Optional<ElasticEntity>	find(Class<ElasticEntity> type, sirius.kernel.commons.Value value) Actually resolves the the type and value into an entity.

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

getEntityRef, getReferencedDescriptor, getReferencedType, getValueFromField, link, onBeforeSaveChecks, onDeleteCascade, onDeleteReject, onDeleteSetNull, setValueToField, transformFromDatasource, transformToDatasource, 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, getValueAsCopy, getValueForDatasource, hashCode, illegalFieldValue, isNullable, 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

ElasticRefProperty

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

Method Detail

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

find

protected Optional<ElasticEntity> find(Class<ElasticEntity> type,
                                       sirius.kernel.commons.Value value)

Description copied from class: BaseEntityRefProperty

Actually resolves the the type and value into an entity.

Specified by:

find in class BaseEntityRefProperty<String,ElasticEntity,ElasticRef<ElasticEntity>>

Parameters:

type - the type to resolve

value - the id to resolve

Returns:

the referenced entity wrapped as optional or an empty optional if no entity was found