sirius.db.mixing.properties

Class SQLEntityRefProperty

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<Long,SQLEntity,SQLEntityRef<SQLEntity>>

sirius.db.mixing.properties.SQLEntityRefProperty

All Implemented Interfaces:

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

public class SQLEntityRefProperty
extends BaseEntityRefProperty<Long,SQLEntity,SQLEntityRef<SQLEntity>>
implements SQLPropertyInfo, ESPropertyInfo

Represents a reference to another SQLEntity field within a Mixable.

Nested Class Summary

Nested Classes

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

elastic, mango

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

components

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SQLEntityRefProperty(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<SQLEntity>	find(Class<SQLEntity> type, sirius.kernel.commons.Value value) Actually resolves the the type and value into an entity.
void	setReferencedEntity(SQLEntity parent, SQLEntity child) Updates the field (SQLEntityRef within the given parent to point to the given child.

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

SQLEntityRefProperty

protected SQLEntityRefProperty(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<SQLEntity> find(Class<SQLEntity> 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<Long,SQLEntity,SQLEntityRef<SQLEntity>>

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

setReferencedEntity

public void setReferencedEntity(SQLEntity parent,
                                SQLEntity child)

Updates the field (SQLEntityRef within the given parent to point to the given child.

It also ensures that the ID is propagated correctly. If a join fetch is executed, the id property might have beend skipped. This will reset the id within the EntityRef to -1, which is the placeholder of the id in the partially fetched entity. Therefore, we remember the original id, which is filled via the foreign key. We then apply the join-fetched value and restore the id (on both sides) if required.

Parameters:

parent - the parent containing the reference to the child

child - the referenced child entity