Module io.ebean.core

Package io.ebeaninternal.server.deploy

Class BeanPropertyAssocMany<T>

java.lang.Object

io.ebeaninternal.server.deploy.BeanProperty

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

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

All Implemented Interfaces:

ScalarDataReader<Object>, ExpressionPath, Property, PropertyAssocMany, ElPropertyDeploy, ElPropertyValue, STreeProperty, STreePropertyAssoc, STreePropertyAssocMany

Direct Known Subclasses:

BeanPropertySimpleCollection

public class BeanPropertyAssocMany<T>
extends BeanPropertyAssoc<T>
implements STreePropertyAssocMany, PropertyAssocMany

Property mapped to a List Set or Map.

Field Summary

Fields inherited from class io.ebeaninternal.server.deploy.BeanProperty

id

Fields inherited from interface io.ebeaninternal.server.el.ElPropertyDeploy

ROOT_ELPREFIX

Constructor Summary

Constructors

Constructor	Description
BeanPropertyAssocMany(BeanDescriptor<?> descriptor, DeployBeanPropertyAssocMany<T> deploy)	Create this property.

Method Summary

Modifier and Type	Method	Description
void	add(BeanCollection<?> collection, EntityBean bean)
void	addBeanToCollectionWithCreate(EntityBean parentBean, EntityBean detailBean, boolean withCheck)	Add the bean to the appropriate collection on the parent bean.
void	addSelectExported(DbSqlContext ctx, String tableAlias)	Append exported columns to the select.
void	addWhereParentIdIn(SpiQuery<?> query, List<Object> parentIds)
void	appendSelect(DbSqlContext ctx, boolean subQuery)	Append to the select clause.
BeanPropertyAssocMany<?>	asMany()	Return as BeanPropertyAssocMany.
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(EntityBean bean)	Return the Id values from the given bean.
String	assocIsEmpty(SpiExpressionRequest request, String path)	Return the logical where clause to support "Is empty".
void	bindElementValue(SqlUpdate insert, Object value)	Bind all the property values to the SqlUpdate.
ElPropertyValue	buildElPropertyValue(String propName, String remainder, ElPropertyChainBuilder chain, boolean propertyDeploy)
IntersectionRow	buildManyDeleteChildren(EntityBean parentBean, Set<Object> excludeDetailIds)
IntersectionRow	buildManyToManyDeleteChildren(EntityBean parentBean)
IntersectionRow	buildManyToManyMapBean(EntityBean parent, EntityBean other)
void	buildRawSqlSelectChain(String prefix, List<String> selectChain)	For RawSql build the select chain.
boolean	containsMany()	Returns true.
BeanCollection<T>	createEmpty(EntityBean parentBean)
void	createEmptyReference(EntityBean localBean)	Populate the collection for read-only disabled lazy loading (aka Java Collections non mutable empty collection).
boolean	createJoinTable()	Returns true, if we must create a m2m join table.
BeanCollection<?>	createReference(EntityBean parentBean)
BeanCollection<?>	createReference(EntityBean localBean, boolean forceNewReference)	Return a reference collection forcing a new reference on REFRESH query.
BeanCollection<?>	createReferenceIfNull(EntityBean parentBean)	Return a reference collection.
SpiSqlUpdate	deleteByParentId(Object parentId)	Create SqlUpdate statement to delete all child beans of the parent id.
SpiSqlUpdate	deleteByParentIdList(List<Object> parentIdist)	Create SqlUpdate statement to delete all child beans of the parent ids in idList.
BeanDescriptor<T>	elementDescriptor()	Return the element bean descriptor (for an element collection only).
String	fetchOrderBy()	Return the order by clause used to order the fetching of the data for this list, set or map.
List<Object>	findIdsByParentId(Object parentId, Transaction t, boolean includeSoftDeletes)	Find the Id's of detail beans given a parent Id
List<Object>	findIdsByParentId(Object parentId, Transaction t, boolean includeSoftDeletes, Set<Object> excludeDetailIds)	Find the Id's of detail beans given a parent Id and optionally exclude detail IDs
List<Object>	findIdsByParentIdList(List<Object> parentIdList, Transaction t, boolean includeSoftDeletes)	Find the Id's of detail beans given a list of parent Id's.
Object	getCacheDataValue(EntityBean bean)	Return the value for this property which we hold in the L2 cache entry.
boolean	hasImportedId(EntityBean otherBean)	Return true if the otherBean has an Id value.
boolean	hasJoinTable()	Return true if this is many to many.
boolean	hasOrderColumn()
void	initialise(io.ebeaninternal.server.deploy.BeanDescriptorInitContext initContext)	Initialise post construction.
SpiSqlUpdate	insertElementCollection()
void	intersectionBind(SqlUpdate sql, EntityBean parentBean, EntityBean other)	Bind the two side of a many to many to the given SqlUpdate.
IntersectionTable	intersectionTable()	Return the intersection table helper.
TableJoin	intersectionTableJoin()	ManyToMany only, join from local table to intersection table.
boolean	isAssocId()	Return true if this is an ManyToOne or OneToOne associated bean property.
boolean	isAssocMany()	Return true if the property is a OneToMany or ManyToMany associated bean property.
boolean	isAssocProperty()	Return true if any path of this path contains a Associated One or Many.
boolean	isCacheDataInclude()	Exclude many properties from bean cache data.
boolean	isElementCollection()
boolean	isIncludeCascadeDelete()
boolean	isIncludeCascadeSave()
boolean	isMany()
boolean	isManyToMany()	Return true if this is many to many.
boolean	isManyToManyWithHistory()	Return true if this is a ManyToMany with history.
boolean	isO2mJoinTable()	Return true if this is a one to many with a join table.
boolean	isOrphanRemoval()
boolean	isSkipSaveBeanCollection(EntityBean bean, boolean insertedParent)	Return true if this is considered 'empty' from a save perspective.
boolean	isUseCache()	Only cache Many Ids if the target bean is also cached.
void	jsonRead(SpiJsonReader readJson, EntityBean parentBean)
Object	jsonReadCollection(SpiJsonReader readJson, EntityBean parentBean, Object targets)	Read the collection (JSON Array) containing entity beans.
void	jsonWrite(SpiJsonWriter ctx, EntityBean bean)	JSON write the bean property.
String	jsonWriteCollection(Object value)	Write the collection to JSON.
void	jsonWriteValue(SpiJsonWriter writeJson, Object value)	Skip JSON write value for ToMany property.
String	lazyFetchOrderBy()	Return the order by for use when lazy loading the associated collection.
void	lazyLoadMany(EntityBean current)	Add the loaded current bean to its associated parent.
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).
ManyType	manyType()	Return the many type.
String	mapKey()	Return the default mapKey when returning a Map.
void	merge(EntityBean bean, EntityBean existing)	Copy collection value if existing is empty.
BeanCollection.ModifyListenMode	modifyListenMode()	Return the mode for listening to modifications to collections for this association.
Object	parentId(EntityBean parentBean)
Collection	rawCollection(EntityBean bean)	Return the underlying collection of beans.
Object	read(DbReadContext ctx)
Object	readSet(DbReadContext ctx, EntityBean bean)
void	registerColumn(BeanDescriptor<?> desc, String prefix)
void	resetMany(EntityBean bean)	Reset the many properties to be empty and ready for reloading.
void	setCacheDataValue(EntityBean bean, Object cacheData, PersistenceContext context)	A Many (element collection) property in bean cache to held as JSON.
void	setEbeanServer(SpiEbeanServer server)	Set the lazy load server to help create reference collections (that lazy load on demand).
void	setParentToChild(EntityBean parent, EntityBean child, Object mapKeyValue)	Set the parent bean to the child (update the relationship).
boolean	setParentToChild(EntityBean parent, EntityBean child, Object mapKeyValue, BeanDescriptor<?> parentDesc)	Return true if the parent bean has been set to the child (updated the relationship).

Methods inherited from class io.ebeaninternal.server.deploy.BeanPropertyAssoc

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

Methods inherited from class io.ebeaninternal.server.deploy.BeanProperty

addTenant, appendFrom, beanProperty, bind, containsFormulaWithJoin, containsManySince, convert, createMutableInfo, dbBind, dbCheckConstraintValues, dbColumn, dbColumnDefault, dbColumnDefn, dbComment, dbEncryptedType, dbLength, dbMigrationInfos, dbScale, dbType, decryptProperty, deployOrder, descriptor, diff, elName, elPlaceholder, elPrefix, encryptKey, encryptKeyAsString, format, fullName, generatedProperty, getCacheDataValueOrig, getValue, getValueIntercept, isAggregation, isArrayType, isAssignableFrom, isDbEncrypted, isDbInsertable, isDbUpdatable, isDDLColumn, isDDLNotNull, isDiscriminator, isEmbedded, isExcludedFromHistory, isFetchEager, isFormula, isGenerated, isId, isImportedPrimaryKey, isJsonSerialize, isLoadProperty, isLob, isLobForPlatform, isLobType, isLocal, isLocalEncrypted, isMutableScalarType, isNaturalKey, isNullable, isSecondaryTable, isSoftDelete, isTenantId, isTransient, isUnique, isUnmappedJson, isVersion, jdbcType, jsonRead, jsonWriteForInsert, localEncrypt, name, override, parse, pathGet, pathGetNested, pathSet, property, propertyIndex, read, readData, readSet, renderDbType, scalarType, secondaryTableJoinPrefix, setDeployOrder, setTenantValue, setValue, setValueChanged, setValueIntercept, stringParser, toString, type, value, writeData

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ebean.plugin.Property

name, type, value

Methods inherited from interface io.ebean.core.type.ScalarDataReader

read

Methods inherited from interface io.ebeaninternal.server.query.STreeProperty

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

Methods inherited from interface io.ebeaninternal.server.query.STreePropertyAssoc

addJoin, addJoin, extraWhere, idBinder, isTargetSoftDelete, setValue, softDeletePredicate, target

Methods inherited from interface io.ebeaninternal.server.query.STreePropertyAssocMany

isExcludedFromHistory

Constructor Details

BeanPropertyAssocMany

public BeanPropertyAssocMany(BeanDescriptor<?> descriptor,
 DeployBeanPropertyAssocMany<T> deploy)

Create this property.

Method Details

initialise

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

Description copied from class: BeanPropertyAssoc

Initialise post construction.

Overrides:

initialise in class BeanPropertyAssoc<T>

asMany

public BeanPropertyAssocMany<?> asMany()

Description copied from interface: STreePropertyAssocMany

Return as BeanPropertyAssocMany.

Specified by:

asMany in interface STreePropertyAssocMany

isManyToManyWithHistory

public boolean isManyToManyWithHistory()

Description copied from interface: STreePropertyAssocMany

Return true if this is a ManyToMany with history.

Specified by:

isManyToManyWithHistory in interface STreePropertyAssocMany

registerColumn

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

Overrides:

registerColumn in class BeanProperty

rawCollection

public Collection rawCollection(EntityBean bean)

Return the underlying collection of beans.

merge

public void merge(EntityBean bean,
 EntityBean existing)

Copy collection value if existing is empty.

Overrides:

merge in class BeanProperty

addBeanToCollectionWithCreate

public void addBeanToCollectionWithCreate(EntityBean parentBean,
 EntityBean detailBean,
 boolean withCheck)

Add the bean to the appropriate collection on the parent bean.

Specified by:

addBeanToCollectionWithCreate in interface STreePropertyAssocMany

isSkipSaveBeanCollection

public boolean isSkipSaveBeanCollection(EntityBean bean,
 boolean insertedParent)

Return true if this is considered 'empty' from a save perspective.

resetMany

public void resetMany(EntityBean bean)

Reset the many properties to be empty and ready for reloading.

Used in bean refresh.

buildElPropertyValue

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

Overrides:

buildElPropertyValue in class BeanProperty

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

deleteByParentId

public SpiSqlUpdate 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>

deleteByParentIdList

public SpiSqlUpdate deleteByParentIdList(List<Object> parentIdist)

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>

findIdsByParentId

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

Find the Id's of detail beans given a parent Id

Specified by:

findIdsByParentId in class BeanPropertyAssoc<T>

findIdsByParentId

public List<Object> findIdsByParentId(Object parentId,
 Transaction t,
 boolean includeSoftDeletes,
 Set<Object> excludeDetailIds)

Find the Id's of detail beans given a parent Id and optionally exclude detail IDs

findIdsByParentIdList

public List<Object> findIdsByParentIdList(List<Object> parentIdList,
 Transaction t,
 boolean includeSoftDeletes)

Find the Id's of detail beans given a list of parent Id's.

Specified by:

findIdsByParentIdList in class BeanPropertyAssoc<T>

isCacheDataInclude

public boolean isCacheDataInclude()

Exclude many properties from bean cache data.

Overrides:

isCacheDataInclude in class BeanProperty

lazyLoadMany

public void lazyLoadMany(EntityBean current)

Add the loaded current bean to its associated parent.

Helper method used by Elastic integration when loading with a persistence context.

Specified by:

lazyLoadMany in interface PropertyAssocMany

addWhereParentIdIn

public void addWhereParentIdIn(SpiQuery<?> query,
 List<Object> parentIds)

setEbeanServer

public void setEbeanServer(SpiEbeanServer server)

Set the lazy load server to help create reference collections (that lazy load on demand).

intersectionTable

public IntersectionTable intersectionTable()

Return the intersection table helper.

modifyListenMode

public BeanCollection.ModifyListenMode modifyListenMode()

Return the mode for listening to modifications to collections for this association.

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

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

readSet

public Object readSet(DbReadContext ctx,
 EntityBean bean)

Overrides:

readSet in class BeanProperty

read

public Object read(DbReadContext ctx)

Overrides:

read in class BeanProperty

add

public void add(BeanCollection<?> collection,
 EntityBean bean)

assocIsEmpty

public String assocIsEmpty(SpiExpressionRequest request,
 String path)

Description copied from interface: ElPropertyValue

Return the logical where clause to support "Is empty".

Specified by:

assocIsEmpty in interface ElPropertyValue

Overrides:

assocIsEmpty in class BeanProperty

assocIdValues

public Object[] assocIdValues(EntityBean bean)

Return the Id values from the given bean.

Specified by:

assocIdValues in interface 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 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

isMany

public boolean isMany()

Specified by:

isMany in interface Property

Overrides:

isMany in class BeanProperty

hasOrderColumn

public boolean hasOrderColumn()

isOrphanRemoval

public boolean isOrphanRemoval()

isAssocMany

public boolean isAssocMany()

Description copied from interface: ElPropertyValue

Return true if the property is a OneToMany or ManyToMany associated bean property.

Specified by:

isAssocMany in interface ElPropertyValue

Overrides:

isAssocMany 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 ExpressionPath

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

containsMany

public boolean containsMany()

Returns true.

Specified by:

containsMany in interface ElPropertyDeploy

Specified by:

containsMany in interface ExpressionPath

Overrides:

containsMany in class BeanProperty

manyType

public ManyType manyType()

Return the many type.

hasJoinTable

public boolean hasJoinTable()

Return true if this is many to many.

Specified by:

hasJoinTable in interface STreePropertyAssocMany

isO2mJoinTable

public boolean isO2mJoinTable()

Return true if this is a one to many with a join table.

isManyToMany

public boolean isManyToMany()

Return true if this is many to many.

isElementCollection

public boolean isElementCollection()

elementDescriptor

public BeanDescriptor<T> elementDescriptor()

Return the element bean descriptor (for an element collection only).

intersectionTableJoin

public TableJoin intersectionTableJoin()

ManyToMany only, join from local table to intersection table.

Specified by:

intersectionTableJoin in interface STreePropertyAssocMany

setParentToChild

public void setParentToChild(EntityBean parent,
 EntityBean child,
 Object mapKeyValue)

Set the parent bean to the child (update the relationship).

setParentToChild

public boolean setParentToChild(EntityBean parent,
 EntityBean child,
 Object mapKeyValue,
 BeanDescriptor<?> parentDesc)

Return true if the parent bean has been set to the child (updated the relationship).

fetchOrderBy

public String fetchOrderBy()

Return the order by clause used to order the fetching of the data for this list, set or map.

lazyFetchOrderBy

public String lazyFetchOrderBy()

Return the order by for use when lazy loading the associated collection.

mapKey

public String mapKey()

Return the default mapKey when returning a Map.

createEmptyReference

public void createEmptyReference(EntityBean localBean)

Description copied from interface: STreePropertyAssocMany

Populate the collection for read-only disabled lazy loading (aka Java Collections non mutable empty collection).

Specified by:

createEmptyReference in interface STreePropertyAssocMany

createReference

public BeanCollection<?> createReference(EntityBean localBean,
 boolean forceNewReference)

Description copied from interface: STreePropertyAssocMany

Return a reference collection forcing a new reference on REFRESH query.

Specified by:

createReference in interface STreePropertyAssocMany

createReferenceIfNull

public BeanCollection<?> createReferenceIfNull(EntityBean parentBean)

Description copied from interface: STreePropertyAssocMany

Return a reference collection.

Specified by:

createReferenceIfNull in interface STreePropertyAssocMany

createReference

public BeanCollection<?> createReference(EntityBean parentBean)

createEmpty

public BeanCollection<T> createEmpty(EntityBean parentBean)

parentId

public Object parentId(EntityBean parentBean)

addSelectExported

public void addSelectExported(DbSqlContext ctx,
 String tableAlias)

Description copied from interface: STreePropertyAssocMany

Append exported columns to the select.

Specified by:

addSelectExported in interface STreePropertyAssocMany

buildManyDeleteChildren

public IntersectionRow buildManyDeleteChildren(EntityBean parentBean,
 Set<Object> excludeDetailIds)

buildManyToManyDeleteChildren

public IntersectionRow buildManyToManyDeleteChildren(EntityBean parentBean)

buildManyToManyMapBean

public IntersectionRow buildManyToManyMapBean(EntityBean parent,
 EntityBean other)

intersectionBind

public void intersectionBind(SqlUpdate sql,
 EntityBean parentBean,
 EntityBean other)

Bind the two side of a many to many to the given SqlUpdate.

hasImportedId

public boolean hasImportedId(EntityBean otherBean)

Return true if the otherBean has an Id value.

jsonWriteValue

public void jsonWriteValue(SpiJsonWriter writeJson,
 Object value)

Skip JSON write value for ToMany property.

Overrides:

jsonWriteValue in class BeanProperty

jsonWrite

public void jsonWrite(SpiJsonWriter ctx,
 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,
 EntityBean parentBean)
              throws IOException

Overrides:

jsonRead in class BeanProperty

Throws:

IOException

isIncludeCascadeSave

public boolean isIncludeCascadeSave()

isIncludeCascadeDelete

public boolean isIncludeCascadeDelete()

insertElementCollection

public SpiSqlUpdate insertElementCollection()

isUseCache

public boolean isUseCache()

Only cache Many Ids if the target bean is also cached.

setCacheDataValue

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

A Many (element collection) property in bean cache to held as JSON.

Overrides:

setCacheDataValue in class BeanProperty

getCacheDataValue

public Object getCacheDataValue(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

jsonWriteCollection

public String jsonWriteCollection(Object value)
                           throws IOException

Write the collection to JSON.

Throws:

IOException

jsonReadCollection

public Object jsonReadCollection(SpiJsonReader readJson,
 EntityBean parentBean,
 Object targets)
                          throws IOException

Read the collection (JSON Array) containing entity beans.

Throws:

IOException

bindElementValue

public void bindElementValue(SqlUpdate insert,
 Object value)

Bind all the property values to the SqlUpdate.

createJoinTable

public boolean createJoinTable()

Returns true, if we must create a m2m join table.