Class BeanPropertyAssocOne<T>

java.lang.Object

io.ebeaninternal.server.deploy.BeanProperty

io.ebeaninternal.server.deploy.BeanPropertyAssoc<T>

io.ebeaninternal.server.deploy.BeanPropertyAssocOne<T>

All Implemented Interfaces:

io.ebean.core.type.ScalarDataReader<Object>, io.ebean.plugin.ExpressionPath, io.ebean.plugin.Property, SpiQueryManyJoin, ElPropertyDeploy, ElPropertyValue, STreeProperty, STreePropertyAssoc, STreePropertyAssocOne

Direct Known Subclasses:

BeanPropertyIdClass

public class BeanPropertyAssocOne<T>
extends BeanPropertyAssoc<T>
implements STreePropertyAssocOne

Property mapped to a joined bean.

Field Summary

Fields inherited from class BeanProperty

id

Fields inherited from interface ElPropertyDeploy

ROOT_ELPREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
	BeanPropertyAssocOne(BeanDescriptorMap owner, BeanDescriptor<?> descriptor, DeployBeanPropertyAssocOne<T> deploy)	Create the property.
	BeanPropertyAssocOne(BeanDescriptorMap owner, DeployBeanPropertyAssocOne<T> deploy)	Create based on deploy information of an EmbeddedId.
protected	BeanPropertyAssocOne(BeanPropertyAssocOne<T> source, io.ebeaninternal.server.deploy.BeanPropertyOverride override)

Method Summary

Modifier and Type	Method	Description
SqlJoinType	addJoin(SqlJoinType joinType, String a1, String a2, DbSqlContext ctx)	Add table join with explicit table alias.
void	addTenant(SpiQuery<?> query, Object tenantId)	Add the tenantId predicate to the query.
void	appendFrom(DbSqlContext ctx, SqlJoinType joinType, String manyWhere)	Add any extra joins required to support this property.
void	appendSelect(DbSqlContext ctx, boolean subQuery)	Append to the select clause.
String	assocIdExpression(String prefix, String operator)	Return the Id expression to add to where clause etc.
String	assocIdInExpr(String prefix)	Return the logical id in expression taking into account embedded id's.
String	assocIdInValueExpr(boolean not, int size)	Return the logical id value expression taking into account embedded id's.
Object[]	assocIdValues(io.ebean.bean.EntityBean bean)	Return the Id values from the given bean.
ElPropertyValue	buildElPropertyValue(String propName, String remainder, ElPropertyChainBuilder chain, boolean propertyDeploy)
void	buildRawSqlSelectChain(String prefix, List<String> selectChain)	For RawSql build the select chain.
Object	createEmbeddedId()	Create a bean of the target type to be used as an embeddedId value.
io.ebean.SqlUpdate	deleteByParentId(Object parentId)	Create SqlUpdate statement to delete all child beans of the parent id.
io.ebean.SqlUpdate	deleteByParentIdList(List<Object> parentIds)	Create SqlUpdate statement to delete all child beans of the parent ids in idList.
void	diff(String prefix, Map<String, io.ebean.ValuePair> map, io.ebean.bean.EntityBean newBean, io.ebean.bean.EntityBean oldBean)	Populate diff map comparing the property values between the beans.
String	elPlaceholder(boolean encrypted)	Return the place holder in the form of ${elPrefix}dbColumn.
List<Object>	findIdsByParentId(Object parentId, io.ebean.Transaction t, boolean includeSoftDeletes)	Find child beans of the parent id.
List<Object>	findIdsByParentIdList(List<Object> parentIds, io.ebean.Transaction t, boolean includeSoftDeletes)	Find child beans of the parent ids in idList.
BeanProperty	findMatchImport(String dbCol)	Find and return a matching imported id property.
String	format(Object value)	Return the value in String format (for bean cache key).
void	freeze(io.ebean.bean.EntityBean entityBean)	Freeze mutable types (like DbArray).
Object	getCacheDataValue(io.ebean.bean.EntityBean bean)	Return the value for this property which we hold in the L2 cache entry.
Object	getCacheDataValueOrig(io.ebean.bean.EntityBeanIntercept ebi)	Return the bean cache value for this property using original values.
boolean	hasCircularImportedId(BeanDescriptor<?> sourceDesc)
boolean	hasForeignKey()	Returns true, if this relation has a foreign key.
io.ebean.core.type.ScalarDataReader<?>	idReader()	Return the scalar type of the associated id property.
ImportedId	importedId()
void	initialise(io.ebeaninternal.server.deploy.BeanDescriptorInitContext initContext)	Initialise post construction.
boolean	isAssocId()	Return true if this is an ManyToOne or OneToOne associated bean property.
boolean	isAssocProperty()	Return true if any path of this path contains a Associated One or Many.
boolean	isOneToOne()	Return true if this a OneToOne property.
boolean	isOneToOneExported()	Return true if this is the exported side of a OneToOne.
boolean	isOrphanRemoval()
boolean	isReference(Object detailBean)
Object	jsonRead(SpiJsonReader readJson)
void	jsonRead(SpiJsonReader readJson, io.ebean.bean.EntityBean bean)
void	jsonWrite(SpiJsonWriter writeJson, io.ebean.bean.EntityBean bean)	JSON write the bean property.
void	jsonWriteForInsert(SpiJsonWriter writeJson, io.ebean.bean.EntityBean bean)	JSON write property (non-recursive to other beans).
void	jsonWriteValue(SpiJsonWriter writeJson, Object value)	JSON write property value (non-recursive to other beans).
void	load(SqlBeanLoad sqlBeanLoad)	Load into the bean (from the DataReader/ResultSet).
void	loadIgnore(DbReadContext ctx)	Ignore the property (moving the column index position without reading).
BeanPropertyAssocOne<?>	override(io.ebeaninternal.server.deploy.BeanPropertyOverride override)
Object	pathGetNested(Object bean)	Return the value ensuring objects prior to the top scalar property are automatically populated.
BeanProperty[]	properties()	Return meta data for the deployment of the embedded bean specific to this property.
Object	read(io.ebean.core.type.DataReader reader)
Object	read(DbReadContext ctx)
Object	readSet(io.ebean.core.type.DataReader reader, io.ebean.bean.EntityBean bean)
Object	readSet(DbReadContext ctx, io.ebean.bean.EntityBean bean)
void	registerColumn(BeanDescriptor<?> desc, String prefix)
void	setCacheDataValue(io.ebean.bean.EntityBean bean, Object cacheData, io.ebean.bean.PersistenceContext context)	Read the value for this property from L2 cache entry and set it to the bean.
void	setParentBeanToChild(io.ebean.bean.EntityBean parent, io.ebean.bean.EntityBean child)	Set the parent bean to the child bean if it has not already been set.
void	setTenantValue(io.ebean.bean.EntityBean entityBean, Object tenantId)	Set the tenantId onto the bean.
void	setValue(io.ebean.bean.EntityBean bean, Object value)	Set the value of the property without interception or PropertyChangeSupport.
void	setValueIntercept(io.ebean.bean.EntityBean bean, Object value)	Set the value of the property.
Class<?>	targetType()	Same as getPropertyType().
io.ebean.bean.EntityBean	valueAsEntityBean(io.ebean.bean.EntityBean owner)	Return the property value as an entity bean.

Methods inherited from class BeanPropertyAssoc

addJoin, beanTable, cascadeInfo, extraWhere, fetchPreference, foreignKey, hasForeignKeyConstraint, hasForeignKeyIndex, hasId, idBinder, isInsertable, isSaveRecurseSkippable, isSaveRecurseSkippable, isScalar, isTargetSoftDelete, isUpdateable, mappedBy, newQuery, softDeletePredicate, tableJoin, target, targetDescriptor, targetIdProperty

Methods inherited from class BeanProperty

assocIsEmpty, beanProperty, bind, containsFormulaWithJoin, containsMany, containsManySince, convert, createMutableInfo, dbBind, dbCheckConstraintValues, dbColumn, dbColumnDefault, dbColumnDefn, dbComment, dbEncryptedType, dbLength, dbMigrationInfos, dbScale, dbType, decryptProperty, deployOrder, descriptor, elName, elPrefix, encryptKey, encryptKeyAsString, fullName, generatedProperty, getValue, getValueIntercept, isAggregation, isArrayType, isAssignableFrom, isAssocMany, isCacheDataInclude, isDbEncrypted, isDbInsertable, isDbUpdatable, isDDLColumn, isDDLNotNull, isDiscriminator, isEmbedded, isExcludedFromHistory, isFetchEager, isFormula, isGenerated, isId, isImportedPrimaryKey, isJsonSerialize, isLoadProperty, isLob, isLobForPlatform, isLobType, isLocal, isLocalEncrypted, isMany, isMutableScalarType, isNaturalKey, isNullable, isSecondaryTable, isSoftDelete, isTenantId, isTransient, isUnique, isUnmappedJson, isVersion, jdbcType, localEncrypt, merge, name, parse, pathGet, pathSet, property, propertyIndex, readData, renderDbType, scalarType, secondaryTableJoinPrefix, setDeployOrder, setValueChanged, stringParser, toString, type, value, writeData

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ElPropertyDeploy

fetchOrderBy, path

Methods inherited from interface STreeProperty

appendGroupBy, elPrefix, encryptKeyAsString, extraIncludes, fullName, isAggregation, isAggregationManyToOne, isEmbedded, isFormula, isId, isLobForPlatform, name, scalarType

Methods inherited from interface STreePropertyAssoc

addJoin, extraWhere, idBinder, isTargetSoftDelete, softDeletePredicate, target

Constructor Details

BeanPropertyAssocOne

public BeanPropertyAssocOne(BeanDescriptorMap owner,
 DeployBeanPropertyAssocOne<T> deploy)

Create based on deploy information of an EmbeddedId.

BeanPropertyAssocOne

public BeanPropertyAssocOne(BeanDescriptorMap owner,
 BeanDescriptor<?> descriptor,
 DeployBeanPropertyAssocOne<T> deploy)

Create the property.

BeanPropertyAssocOne

protected BeanPropertyAssocOne(BeanPropertyAssocOne<T> source,
 io.ebeaninternal.server.deploy.BeanPropertyOverride override)

Method Details

override

public BeanPropertyAssocOne<?> override(io.ebeaninternal.server.deploy.BeanPropertyOverride override)

Overrides:

override in class BeanProperty

initialise

public void initialise(io.ebeaninternal.server.deploy.BeanDescriptorInitContext initContext)

Description copied from class: BeanPropertyAssoc

Initialise post construction.

Overrides:

initialise in class BeanPropertyAssoc<T>

valueAsEntityBean

public io.ebean.bean.EntityBean valueAsEntityBean(io.ebean.bean.EntityBean owner)

Return the property value as an entity bean.

Specified by:

valueAsEntityBean in interface STreePropertyAssocOne

buildElPropertyValue

public ElPropertyValue buildElPropertyValue(String propName,
 String remainder,
 ElPropertyChainBuilder chain,
 boolean propertyDeploy)

Overrides:

buildElPropertyValue in class BeanProperty

elPlaceholder

public String elPlaceholder(boolean encrypted)

Description copied from interface: ElPropertyDeploy

Return the place holder in the form of ${elPrefix}dbColumn.

The ${elPrefix} is replaced by the appropriate table alias.

Specified by:

elPlaceholder in interface ElPropertyDeploy

Overrides:

elPlaceholder in class BeanProperty

deleteByParentIdList

public io.ebean.SqlUpdate deleteByParentIdList(List<Object> parentIds)

Description copied from class: BeanPropertyAssoc

Create SqlUpdate statement to delete all child beans of the parent ids in idList.

Specified by:

deleteByParentIdList in class BeanPropertyAssoc<T>

deleteByParentId

public io.ebean.SqlUpdate deleteByParentId(Object parentId)

Description copied from class: BeanPropertyAssoc

Create SqlUpdate statement to delete all child beans of the parent id.

Specified by:

deleteByParentId in class BeanPropertyAssoc<T>

findIdsByParentId

public List<Object> findIdsByParentId(Object parentId,
 io.ebean.Transaction t,
 boolean includeSoftDeletes)

Description copied from class: BeanPropertyAssoc

Find child beans of the parent id.

Specified by:

findIdsByParentId in class BeanPropertyAssoc<T>

findIdsByParentIdList

public List<Object> findIdsByParentIdList(List<Object> parentIds,
 io.ebean.Transaction t,
 boolean includeSoftDeletes)

Description copied from class: BeanPropertyAssoc

Find child beans of the parent ids in idList.

Specified by:

findIdsByParentIdList in class BeanPropertyAssoc<T>

registerColumn

public void registerColumn(BeanDescriptor<?> desc,
 String prefix)

Overrides:

registerColumn in class BeanProperty

properties

public BeanProperty[] properties()

Return meta data for the deployment of the embedded bean specific to this property.

buildRawSqlSelectChain

public void buildRawSqlSelectChain(String prefix,
 List<String> selectChain)

Description copied from interface: STreeProperty

For RawSql build the select chain.

Specified by:

buildRawSqlSelectChain in interface STreeProperty

Overrides:

buildRawSqlSelectChain in class BeanProperty

hasForeignKey

public boolean hasForeignKey()

Description copied from interface: STreePropertyAssocOne

Returns true, if this relation has a foreign key.

Specified by:

hasForeignKey in interface STreePropertyAssocOne

isOneToOne

public boolean isOneToOne()

Return true if this a OneToOne property. Otherwise assumed ManyToOne.

isOneToOneExported

public boolean isOneToOneExported()

Return true if this is the exported side of a OneToOne.

isOrphanRemoval

public boolean isOrphanRemoval()

diff

public void diff(String prefix,
 Map<String, io.ebean.ValuePair> map,
 io.ebean.bean.EntityBean newBean,
 io.ebean.bean.EntityBean oldBean)

Description copied from class: BeanProperty

Populate diff map comparing the property values between the beans.

Overrides:

diff in class BeanProperty

targetType

public Class<?> targetType()

Same as getPropertyType(). Return the type of the bean this property represents.

Overrides:

targetType in class BeanPropertyAssoc<T>

getCacheDataValueOrig

public Object getCacheDataValueOrig(io.ebean.bean.EntityBeanIntercept ebi)

Return the bean cache value for this property using original values.

Overrides:

getCacheDataValueOrig in class BeanProperty

getCacheDataValue

public Object getCacheDataValue(io.ebean.bean.EntityBean bean)

Description copied from class: BeanProperty

Return the value for this property which we hold in the L2 cache entry.

This uses format() where possible to store the value as a string and this is done to make any resulting Java object serialisation content smaller as strings get special treatment.

Overrides:

getCacheDataValue in class BeanProperty

format

public String format(Object value)

Description copied from class: BeanProperty

Return the value in String format (for bean cache key).

Overrides:

format in class BeanProperty

setCacheDataValue

public void setCacheDataValue(io.ebean.bean.EntityBean bean,
 Object cacheData,
 io.ebean.bean.PersistenceContext context)

Description copied from class: BeanProperty

Read the value for this property from L2 cache entry and set it to the bean.

This uses parse() as per the comment in getCacheDataValue().

Overrides:

setCacheDataValue in class BeanProperty

idReader

public io.ebean.core.type.ScalarDataReader<?> idReader()

Description copied from interface: STreePropertyAssocOne

Return the scalar type of the associated id property.

Specified by:

idReader in interface STreePropertyAssocOne

assocIdValues

public Object[] assocIdValues(io.ebean.bean.EntityBean bean)

Return the Id values from the given bean.

Specified by:

assocIdValues in interface io.ebean.plugin.ExpressionPath

Overrides:

assocIdValues in class BeanProperty

assocIdExpression

public String assocIdExpression(String prefix,
 String operator)

Return the Id expression to add to where clause etc.

Specified by:

assocIdExpression in interface io.ebean.plugin.ExpressionPath

Overrides:

assocIdExpression in class BeanProperty

assocIdInValueExpr

public String assocIdInValueExpr(boolean not,
 int size)

Return the logical id value expression taking into account embedded id's.

Specified by:

assocIdInValueExpr in interface ElPropertyValue

Overrides:

assocIdInValueExpr in class BeanProperty

assocIdInExpr

public String assocIdInExpr(String prefix)

Return the logical id in expression taking into account embedded id's.

Specified by:

assocIdInExpr in interface ElPropertyValue

Overrides:

assocIdInExpr in class BeanProperty

isAssocId

public boolean isAssocId()

Description copied from interface: ElPropertyValue

Return true if this is an ManyToOne or OneToOne associated bean property.

Specified by:

isAssocId in interface ElPropertyValue

Specified by:

isAssocId in interface io.ebean.plugin.ExpressionPath

Specified by:

isAssocId in interface STreePropertyAssocOne

Overrides:

isAssocId in class BeanProperty

isAssocProperty

public boolean isAssocProperty()

Description copied from interface: ElPropertyValue

Return true if any path of this path contains a Associated One or Many.

Specified by:

isAssocProperty in interface ElPropertyValue

Overrides:

isAssocProperty in class BeanProperty

createEmbeddedId

public Object createEmbeddedId()

Create a bean of the target type to be used as an embeddedId value.

pathGetNested

public Object pathGetNested(Object bean)

Description copied from interface: ElPropertyValue

Return the value ensuring objects prior to the top scalar property are automatically populated.

Specified by:

pathGetNested in interface ElPropertyValue

Overrides:

pathGetNested in class BeanProperty

importedId

public ImportedId importedId()

findMatchImport

public BeanProperty findMatchImport(String dbCol)

Find and return a matching imported id property.

appendSelect

public void appendSelect(DbSqlContext ctx,
 boolean subQuery)

Description copied from interface: STreeProperty

Append to the select clause.

Specified by:

appendSelect in interface STreeProperty

Overrides:

appendSelect in class BeanProperty

addJoin

public SqlJoinType addJoin(SqlJoinType joinType,
 String a1,
 String a2,
 DbSqlContext ctx)

Add table join with explicit table alias.

Specified by:

addJoin in interface STreePropertyAssoc

Overrides:

addJoin in class BeanPropertyAssoc<T>

appendFrom

public void appendFrom(DbSqlContext ctx,
 SqlJoinType joinType,
 String manyWhere)

Description copied from class: BeanProperty

Add any extra joins required to support this property. Generally a no operation except for a OneToOne exported.

Specified by:

appendFrom in interface STreeProperty

Overrides:

appendFrom in class BeanProperty

readSet

public Object readSet(io.ebean.core.type.DataReader reader,
 io.ebean.bean.EntityBean bean)
               throws SQLException

Overrides:

readSet in class BeanProperty

Throws:

SQLException

read

public Object read(io.ebean.core.type.DataReader reader)
            throws SQLException

Specified by:

read in interface io.ebean.core.type.ScalarDataReader<T>

Overrides:

read in class BeanProperty

Throws:

SQLException

readSet

public Object readSet(DbReadContext ctx,
 io.ebean.bean.EntityBean bean)
               throws SQLException

Overrides:

readSet in class BeanProperty

Throws:

SQLException

read

public Object read(DbReadContext ctx)
            throws SQLException

Overrides:

read in class BeanProperty

Throws:

SQLException

addTenant

public void addTenant(SpiQuery<?> query,
 Object tenantId)

Description copied from class: BeanProperty

Add the tenantId predicate to the query.

Overrides:

addTenant in class BeanProperty

setTenantValue

public void setTenantValue(io.ebean.bean.EntityBean entityBean,
 Object tenantId)

Description copied from class: BeanProperty

Set the tenantId onto the bean.

Overrides:

setTenantValue in class BeanProperty

freeze

public void freeze(io.ebean.bean.EntityBean entityBean)

Description copied from class: BeanProperty

Freeze mutable types (like DbArray).

Overrides:

freeze in class BeanProperty

setValue

public void setValue(io.ebean.bean.EntityBean bean,
 Object value)

Description copied from class: BeanProperty

Set the value of the property without interception or PropertyChangeSupport.

Specified by:

setValue in interface STreePropertyAssoc

Overrides:

setValue in class BeanProperty

setValueIntercept

public void setValueIntercept(io.ebean.bean.EntityBean bean,
 Object value)

Description copied from class: BeanProperty

Set the value of the property.

Overrides:

setValueIntercept in class BeanProperty

loadIgnore

public void loadIgnore(DbReadContext ctx)

Description copied from interface: STreeProperty

Ignore the property (moving the column index position without reading).

Specified by:

loadIgnore in interface STreeProperty

Overrides:

loadIgnore in class BeanProperty

load

public void load(SqlBeanLoad sqlBeanLoad)

Description copied from interface: STreeProperty

Load into the bean (from the DataReader/ResultSet).

Specified by:

load in interface STreeProperty

Overrides:

load in class BeanProperty

jsonWriteForInsert

public void jsonWriteForInsert(SpiJsonWriter writeJson,
 io.ebean.bean.EntityBean bean)
                        throws IOException

JSON write property (non-recursive to other beans).

Overrides:

jsonWriteForInsert in class BeanProperty

Throws:

IOException

jsonWriteValue

public void jsonWriteValue(SpiJsonWriter writeJson,
 Object value)
                    throws IOException

JSON write property value (non-recursive to other beans).

Overrides:

jsonWriteValue in class BeanProperty

Throws:

IOException

jsonWrite

public void jsonWrite(SpiJsonWriter writeJson,
 io.ebean.bean.EntityBean bean)
               throws IOException

Description copied from class: BeanProperty

JSON write the bean property.

Overrides:

jsonWrite in class BeanProperty

Throws:

IOException

jsonRead

public void jsonRead(SpiJsonReader readJson,
 io.ebean.bean.EntityBean bean)
              throws IOException

Overrides:

jsonRead in class BeanProperty

Throws:

IOException

jsonRead

public Object jsonRead(SpiJsonReader readJson)
                throws IOException

Overrides:

jsonRead in class BeanProperty

Throws:

IOException

isReference

public boolean isReference(Object detailBean)

setParentBeanToChild

public void setParentBeanToChild(io.ebean.bean.EntityBean parent,
 io.ebean.bean.EntityBean child)

Set the parent bean to the child bean if it has not already been set.

hasCircularImportedId

public boolean hasCircularImportedId(BeanDescriptor<?> sourceDesc)