java.lang.Object
- org.hibernate.persister.collection.AbstractCollectionPersister

All Implemented Interfaces:

FetchProfileAffectee, CollectionMetadata, FilterRestrictable, PluralAttributeMappingImpl.Aware, Restrictable, WhereRestrictable, CollectionPersister, DeprecatedCollectionStuff, CollectionMutationTarget, QueryableCollection, SQLLoadableCollection, Joinable, PropertyMapping, MutationTarget<CollectionTableMapping>

Direct Known Subclasses:

BasicCollectionPersister, OneToManyPersister
```
@Internal
public abstract class AbstractCollectionPersister
extends Object
implements CollectionPersister, CollectionMutationTarget, PluralAttributeMappingImpl.Aware, FetchProfileAffectee, DeprecatedCollectionStuff
```
Base implementation of the QueryableCollection interface.

See Also:

BasicCollectionPersister, OneToManyPersister

Field Summary

Fields
Modifier and Type	Field	Description
`protected int`	`batchSize`
`protected String[]`	`elementColumnAliases`	Deprecated.
`protected boolean[]`	`elementColumnIsGettable`
`protected boolean[]`	`elementColumnIsSettable`
`protected String[]`	`elementColumnNames`
`protected String[]`	`elementColumnReaders`
`protected String[]`	`elementColumnReaderTemplates`
`protected String[]`	`elementColumnWriters`
`protected String[]`	`elementFormulas`
`protected String[]`	`elementFormulaTemplates`
`protected boolean`	`elementIsPureFormula`
`protected Type`	`elementType`	Deprecated.
`protected boolean`	`hasWhere`
`protected String`	`identifierColumnName`
`protected String[]`	`indexColumnAliases`	Deprecated.
`protected boolean[]`	`indexColumnIsGettable`
`protected boolean[]`	`indexColumnIsSettable`
`protected String[]`	`indexColumnNames`
`protected boolean`	`indexContainsFormula`
`protected String[]`	`indexFormulas`
`protected String[]`	`indexFormulaTemplates`
`protected boolean`	`isInverse`
`protected String[]`	`keyColumnAliases`	Deprecated.
`protected String[]`	`keyColumnNames`
`protected String`	`qualifiedTableName`
`protected SqlExceptionHelper`	`sqlExceptionHelper`
`protected String`	`sqlWhereString`

Constructor Summary

Constructors
Constructor	Description
`AbstractCollectionPersister(Collection collectionBootDescriptor, CollectionDataAccess cacheAccessStrategy, RuntimeModelCreationContext creationContext)`
`AbstractCollectionPersister(Collection collectionBootDescriptor, CollectionDataAccess cacheAccessStrategy, PersisterCreationContext creationContext)`	Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`applyBaseManyToManyRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, Map<String,Filter> enabledFilters, Set<String> treatAsDeclarations, SqlAstCreationState creationState)`
`void`	`applyBaseRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, Map<String,Filter> enabledFilters, Set<String> treatAsDeclarations, SqlAstCreationState creationState)`	Applies the base set of restrictions.
`void`	`applyFilterRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, Map<String,Filter> enabledFilters, SqlAstCreationState creationState)`	Applies just the `Filter` values enabled for the associated entity
`protected void`	`applyWhereFragments(Consumer<Predicate> predicateConsumer, String alias, TableGroup tableGroup, SqlAstCreationState astCreationState)`
`void`	`applyWhereRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, SqlAstCreationState creationState)`	Apply the `Where` restrictions
`protected JdbcMutationOperation`	`buildDeleteAllOperation(MutatingTableReference tableReference)`
`protected CollectionLoader`	`createCollectionLoader(LoadQueryInfluencers loadQueryInfluencers)`
`protected CollectionLoader`	`createSubSelectLoader(SubselectFetch subselect, SharedSessionContractImplementor session)`
`protected @Remove Object`	`decrementIndexByBase(Object index)`	Deprecated, for removal: This API element is subject to removal in a future version. No longer used.
`protected CollectionLoader`	`determineLoaderToUse(Object key, SharedSessionContractImplementor session)`
`protected String`	`determineTableName(Table table)`
`protected abstract void`	`doProcessQueuedOps(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)`
`boolean`	`elementExists(Object key, Object element, SharedSessionContractImplementor session)`
`void`	`forEachMutableTable(Consumer<CollectionTableMapping> consumer)`	Visit each table.
`void`	`forEachMutableTableReverse(Consumer<CollectionTableMapping> consumer)`	Same as `MutationTarget.forEachMutableTable(java.util.function.Consumer<T>)` except that here the tables are visited in reverse order
`RestrictedTableMutation<JdbcMutationOperation>`	`generateDeleteAllAst(MutatingTableReference tableReference)`
`protected String`	`generateDetectRowByElementString()`
`protected String`	`generateDetectRowByIndexString()`
`protected String`	`generateSelectSizeString(boolean isIntegerIndexed)`
`PluralAttributeMapping`	`getAttributeMapping()`
`int`	`getBatchSize()`
`CollectionDataAccess`	`getCacheAccessStrategy()`	Access to the collection's cache region
`CacheEntryStructure`	`getCacheEntryStructure()`	Get the structure used to store data into the collection's cache region
`CollectionMetadata`	`getCollectionMetadata()`	Deprecated.
`String[]`	`getCollectionPropertyColumnAliases(String propertyName, String suffix)`
`CollectionSemantics<?,?>`	`getCollectionSemantics()`
`String[]`	`getCollectionSpaces()`	Get the "space" that holds the persistent state
`CollectionTableMapping`	`getCollectionTableMapping()`
`CollectionType`	`getCollectionType()`	Get the associated `Type`
`protected Dialect`	`getDialect()`
`Object`	`getElementByIndex(Object key, Object index, SharedSessionContractImplementor session, Object owner)`
`Class<?>`	`getElementClass()`	Return the element class of an array, or null otherwise.
`String[]`	`getElementColumnAliases(String suffix)`	Generates the collection's element column aliases, based on the given suffix.
`String[]`	`getElementColumnNames()`	Get the names of the collection element columns (or the primary key columns in the case of a one-to-many association)
`String[]`	`getElementColumnNames(String alias)`	Get the names of the collection element columns (or the primary key columns in the case of a one-to-many association), aliased by the given table alias
`EntityPersister`	`getElementPersister()`	Get the persister of the element class, if this is a collection of entities (optional operation).
`protected EntityPersister`	`getElementPersisterInternal()`
`Type`	`getElementType()`	Get the "element" type
`SessionFactoryImplementor`	`getFactory()`
`FetchMode`	`getFetchMode()`	Should we load this collection role by outerjoining?
`abstract FilterAliasGenerator`	`getFilterAliasGenerator(String rootAlias)`
`abstract FilterAliasGenerator`	`getFilterAliasGenerator(TableGroup tableGroup)`
`BeforeExecutionGenerator`	`getGenerator()`	Get the surrogate key generation strategy (optional operation)
`String`	`getIdentifierColumnAlias(String suffix)`	Generates the collection's identifier column aliases, based on the given suffix.
`String`	`getIdentifierColumnName()`
`IdentifierGenerator`	`getIdentifierGenerator()`	Deprecated.
`String`	`getIdentifierTableName()`	The name of the table defining the identifier for this target
`Type`	`getIdentifierType()`	Get the type of the surrogate key
`String[]`	`getIndexColumnAliases(String suffix)`	Generates the collection's index column aliases, based on the given suffix.
`String[]`	`getIndexColumnNames()`	Get the names of the collection index columns if this is an indexed collection (optional operation)
`String[]`	`getIndexColumnNames(String alias)`	Get the names of the collection index columns if this is an indexed collection (optional operation), aliased by the given table alias
`String[]`	`getIndexFormulas()`	Get the index formulas if this is an indexed collection (optional operation)
`Type`	`getIndexType()`	Get the "index" type for a list or map (optional operation)
`String[]`	`getKeyColumnAliases(String suffix)`	Generates the collection's key column aliases, based on the given suffix.
`String[]`	`getKeyColumnNames()`	The columns to join on
`Type`	`getKeyType()`	Get the "key" type (the type of the foreign key)
`String`	`getManyToManyFilterFragment(TableGroup tableGroup, Map<String,Filter> enabledFilters)`
`String`	`getManyToManyOrderByString(String alias)`	Get the order-by to be applied at the target table of a many to many
`String`	`getMappedByProperty()`
`String`	`getName()`	An identifying name; a class name or collection role name.
`NavigableRole`	`getNavigableRole()`	The NavigableRole for this collection.
`String`	`getOwnerEntityName()`
`EntityPersister`	`getOwnerEntityPersister()`	Get the persister of the entity that "owns" this collection
`protected abstract RemoveCoordinator`	`getRemoveCoordinator()`
`protected abstract RowMutationOperations`	`getRowMutationOperations()`
`int`	`getSize(Object key, SharedSessionContractImplementor session)`
`Comparator<?>`	`getSortingComparator()`	For sorted collections, the comparator to use.
`protected SqlExceptionHelper`	`getSQLExceptionHelper()`
`String`	`getSQLOrderByString(String alias)`	Get the order by SQL
`protected CollectionLoader`	`getStandardCollectionLoader()`
`String`	`getTableName()`	The table to join to.
`PluralAttributeMapping`	`getTargetPart()`	The ModelPart describing the mutation target
`boolean`	`hasCache()`	Is this collection role cacheable
`boolean`	`hasIndex()`	Is this an "indexed" collection? (list or map)
`boolean`	`hasManyToManyOrdering()`
`boolean`	`hasOrdering()`	Is this an ordered collection? (An ordered collection is ordered by the initialization operation, not by sorting that happens in memory, as in the case of a sorted collection.)
`boolean`	`hasOrphanDelete()`	Does this collection implement "orphan delete"?
`boolean`	`hasPhysicalIndexColumn()`	Whether the collection has at least one physical index column
`boolean`	`hasWhere()`	Does this collection role have a where clause filter?
`protected Object`	`incrementIndexByBase(Object index)`
`boolean`	`indexExists(Object key, Object index, SharedSessionContractImplementor session)`
`void`	`initCollectionPropertyMap()`
`void`	`initialize(Object key, SharedSessionContractImplementor session)`	Initialize the given collection with the given key
`void`	`injectAttributeMapping(PluralAttributeMapping attributeMapping)`	Allows injection of the corresponding plural-attribute mapping.
`boolean`	`isAffectedByEnabledFetchProfiles(LoadQueryInfluencers influencers)`
`boolean`	`isAffectedByEnabledFilters(LoadQueryInfluencers influencers)`
`boolean`	`isAffectedByEnabledFilters(SharedSessionContractImplementor session)`
`boolean`	`isAffectedByEntityGraph(LoadQueryInfluencers influencers)`
`boolean`	`isArray()`	Is this an array?
`boolean`	`isCollection()`	Is this instance actually a CollectionPersister?
`boolean`	`isExtraLazy()`
`boolean`	`isInverse()`	Is this collection "inverse", so state changes are not propagated to the database.
`boolean`	`isLazy()`	Is this collection lazily initialized?
`abstract boolean`	`isManyToMany()`	Is this a many-to-many association? Note that this is mainly a convenience feature as the single persister does not contain all the information needed to handle a many-to-many itself, as internally it is looked at as two many-to-ones.
`boolean`	`isMutable()`	Can the elements of this collection change?
`boolean`	`isPrimitiveArray()`	Is this an array or primitive values?
`protected boolean`	`isRowDeleteEnabled()`
`protected boolean`	`isRowInsertEnabled()`
`boolean`	`isSubselectLoadable()`
`boolean`	`isVersioned()`	Does this collection cause version increment of the owning entity?
`protected void`	`logStaticSQL()`
`boolean`	`needsRemove()`	Whether `CollectionPersister.remove(Object, SharedSessionContractImplementor)` might actually do something, or if it is definitely a no-op.
`void`	`postInstantiate()`
`void`	`processQueuedOps(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)`	Process queued operations within the PersistentCollection.
`void`	`registerAffectingFetchProfile(String fetchProfileName, Fetch.Style fetchStyle)`	Register the profile name with the entity/collection
`void`	`remove(Object id, SharedSessionContractImplementor session)`	Completely remove the persistent state of the collection
`String`	`selectFragment(String alias, String columnSuffix)`	Generate a list of collection index, key and element columns
`String[]`	`toColumns(String propertyName)`	Given a property path, return the corresponding column name(s).
`String`	`toString()`
`Type`	`toType(String propertyName)`	Given a component path expression, get the type of the property

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.persister.collection.mutation.CollectionMutationTarget
getIdentifierTableMapping

Methods inherited from interface org.hibernate.persister.collection.CollectionPersister
deleteRows, insertRows, isCascadeDeleteEnabled, isOneToMany, recreate, updateRows

Methods inherited from interface org.hibernate.persister.collection.DeprecatedCollectionStuff
getRole

Methods inherited from interface org.hibernate.persister.entity.Joinable
consumesCollectionAlias, consumesEntityAlias

Methods inherited from interface org.hibernate.sql.model.MutationTarget
getRolePath

- Field Detail
  - qualifiedTableName
```
protected final String qualifiedTableName
```
  - hasWhere
```
protected final boolean hasWhere
```
  - sqlWhereString
```
protected final String sqlWhereString
```
  - indexContainsFormula
```
protected final boolean indexContainsFormula
```
  - elementIsPureFormula
```
protected final boolean elementIsPureFormula
```
  - keyColumnNames
```
protected final String[] keyColumnNames
```
  - indexColumnNames
```
protected final String[] indexColumnNames
```
  - indexFormulaTemplates
```
protected final String[] indexFormulaTemplates
```
  - indexFormulas
```
protected final String[] indexFormulas
```
  - indexColumnIsGettable
```
protected final boolean[] indexColumnIsGettable
```
  - indexColumnIsSettable
```
protected final boolean[] indexColumnIsSettable
```
  - elementColumnNames
```
protected final String[] elementColumnNames
```
  - elementColumnWriters
```
protected final String[] elementColumnWriters
```
  - elementColumnReaders
```
protected final String[] elementColumnReaders
```
  - elementColumnReaderTemplates
```
protected final String[] elementColumnReaderTemplates
```
  - elementFormulaTemplates
```
protected final String[] elementFormulaTemplates
```
  - elementFormulas
```
protected final String[] elementFormulas
```
  - elementColumnIsGettable
```
protected final boolean[] elementColumnIsGettable
```
  - elementColumnIsSettable
```
protected final boolean[] elementColumnIsSettable
```
  - identifierColumnName
```
protected final String identifierColumnName
```
  - isInverse
```
protected final boolean isInverse
```
  - batchSize
```
protected final int batchSize
```
  - sqlExceptionHelper
```
protected final SqlExceptionHelper sqlExceptionHelper
```
  - elementType
```
@Deprecated
protected final Type elementType
```
    Deprecated.
  - keyColumnAliases
```
@Deprecated
protected final String[] keyColumnAliases
```
    Deprecated.
  - indexColumnAliases
```
@Deprecated
protected final String[] indexColumnAliases
```
    Deprecated.
  - elementColumnAliases
```
@Deprecated
protected final String[] elementColumnAliases
```
    Deprecated.
- Constructor Detail
  - AbstractCollectionPersister
```
@Deprecated(since="6.0")
public AbstractCollectionPersister(Collection collectionBootDescriptor,
                                   CollectionDataAccess cacheAccessStrategy,
                                   PersisterCreationContext creationContext)
                            throws MappingException,
                                   CacheException
```
    Deprecated.
    
    Throws:
    
    MappingException
    
    CacheException
  - AbstractCollectionPersister
```
public AbstractCollectionPersister(Collection collectionBootDescriptor,
                                   CollectionDataAccess cacheAccessStrategy,
                                   RuntimeModelCreationContext creationContext)
                            throws MappingException,
                                   CacheException
```
    Throws:
    
    MappingException
    
    CacheException
- Method Detail
  - getNavigableRole
```
public NavigableRole getNavigableRole()
```
    Description copied from interface: CollectionPersister
    
    The NavigableRole for this collection.
    
    Specified by:
    
    getNavigableRole in interface CollectionPersister
    
    Specified by:
    
    getNavigableRole in interface MutationTarget<CollectionTableMapping>
  - getSortingComparator
```
public Comparator<?> getSortingComparator()
```
    Description copied from interface: CollectionPersister
    
    For sorted collections, the comparator to use. Non-parameterized because for SORTED_SET the elements are compared but for SORTED_MAP the keys are compared
    
    Specified by:
    
    getSortingComparator in interface CollectionPersister
    
    See Also:
    
    CollectionClassification.SORTED_MAP, CollectionClassification.SORTED_SET
  - determineTableName
```
protected String determineTableName(Table table)
```
  - postInstantiate
```
public void postInstantiate()
                     throws MappingException
```
    Specified by:
    
    postInstantiate in interface CollectionPersister
    
    Throws:
    
    MappingException
  - logStaticSQL
```
protected void logStaticSQL()
```
  - initialize
```
public void initialize(Object key,
                       SharedSessionContractImplementor session)
                throws HibernateException
```
    Description copied from interface: CollectionPersister
    
    Initialize the given collection with the given key
    
    Specified by:
    
    initialize in interface CollectionPersister
    
    Throws:
    
    HibernateException
  - getStandardCollectionLoader
```
protected CollectionLoader getStandardCollectionLoader()
```
  - determineLoaderToUse
```
protected CollectionLoader determineLoaderToUse(Object key,
                                                SharedSessionContractImplementor session)
```
  - createSubSelectLoader
```
protected CollectionLoader createSubSelectLoader(SubselectFetch subselect,
                                                 SharedSessionContractImplementor session)
```
  - createCollectionLoader
```
protected CollectionLoader createCollectionLoader(LoadQueryInfluencers loadQueryInfluencers)
```
  - getCacheAccessStrategy
```
public CollectionDataAccess getCacheAccessStrategy()
```
    Description copied from interface: CollectionPersister
    
    Access to the collection's cache region
    
    Specified by:
    
    getCacheAccessStrategy in interface CollectionPersister
  - hasCache
```
public boolean hasCache()
```
    Description copied from interface: CollectionPersister
    
    Is this collection role cacheable
    
    Specified by:
    
    hasCache in interface CollectionPersister
  - getRowMutationOperations
```
protected abstract RowMutationOperations getRowMutationOperations()
```
  - getRemoveCoordinator
```
protected abstract RemoveCoordinator getRemoveCoordinator()
```
  - getSQLOrderByString
```
public String getSQLOrderByString(String alias)
```
    Description copied from interface: QueryableCollection
    
    Get the order by SQL
    
    Specified by:
    
    getSQLOrderByString in interface QueryableCollection
  - getManyToManyOrderByString
```
public String getManyToManyOrderByString(String alias)
```
    Description copied from interface: QueryableCollection
    
    Get the order-by to be applied at the target table of a many to many
    
    Specified by:
    
    getManyToManyOrderByString in interface QueryableCollection
    
    Parameters:
    
    alias - The alias for the many-to-many target table
    
    Returns:
    
    appropriate order-by fragment or empty string.
  - getFetchMode
```
public FetchMode getFetchMode()
```
    Description copied from interface: QueryableCollection
    
    Should we load this collection role by outerjoining?
    
    Specified by:
    
    getFetchMode in interface QueryableCollection
  - hasOrdering
```
public boolean hasOrdering()
```
    Description copied from interface: CollectionPersister
    
    Is this an ordered collection? (An ordered collection is ordered by the initialization operation, not by sorting that happens in memory, as in the case of a sorted collection.)
    
    Specified by:
    
    hasOrdering in interface CollectionPersister
  - hasManyToManyOrdering
```
public boolean hasManyToManyOrdering()
```
    Specified by:
    
    hasManyToManyOrdering in interface CollectionPersister
  - hasWhere
```
public boolean hasWhere()
```
    Description copied from interface: QueryableCollection
    
    Does this collection role have a where clause filter?
    
    Specified by:
    
    hasWhere in interface QueryableCollection
  - getElementClass
```
public Class<?> getElementClass()
```
    Return the element class of an array, or null otherwise. needed by arrays
    
    Specified by:
    
    getElementClass in interface CollectionPersister
  - decrementIndexByBase
```
@Deprecated(forRemoval=true)
@Remove
protected @Remove Object decrementIndexByBase(Object index)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    No longer used.
  - incrementIndexByBase
```
protected Object incrementIndexByBase(Object index)
```
  - isPrimitiveArray
```
public boolean isPrimitiveArray()
```
    Description copied from interface: CollectionPersister
    
    Is this an array or primitive values?
    
    Specified by:
    
    isPrimitiveArray in interface CollectionMetadata
    
    Specified by:
    
    isPrimitiveArray in interface CollectionPersister
  - isArray
```
public boolean isArray()
```
    Description copied from interface: CollectionPersister
    
    Is this an array?
    
    Specified by:
    
    isArray in interface CollectionMetadata
    
    Specified by:
    
    isArray in interface CollectionPersister
  - getIdentifierColumnName
```
public String getIdentifierColumnName()
```
    Specified by:
    
    getIdentifierColumnName in interface SQLLoadableCollection
  - selectFragment
```
public String selectFragment(String alias,
                             String columnSuffix)
```
    Generate a list of collection index, key and element columns
    
    Specified by:
    
    selectFragment in interface QueryableCollection
  - generateSelectSizeString
```
protected String generateSelectSizeString(boolean isIntegerIndexed)
```
  - generateDetectRowByIndexString
```
protected String generateDetectRowByIndexString()
```
  - generateDetectRowByElementString
```
protected String generateDetectRowByElementString()
```
  - getIndexColumnNames
```
public String[] getIndexColumnNames()
```
    Description copied from interface: QueryableCollection
    
    Get the names of the collection index columns if this is an indexed collection (optional operation)
    
    Specified by:
    
    getIndexColumnNames in interface QueryableCollection
  - getIndexFormulas
```
public String[] getIndexFormulas()
```
    Description copied from interface: QueryableCollection
    
    Get the index formulas if this is an indexed collection (optional operation)
    
    Specified by:
    
    getIndexFormulas in interface QueryableCollection
  - getIndexColumnNames
```
public String[] getIndexColumnNames(String alias)
```
    Description copied from interface: QueryableCollection
    
    Get the names of the collection index columns if this is an indexed collection (optional operation), aliased by the given table alias
    
    Specified by:
    
    getIndexColumnNames in interface QueryableCollection
  - getElementColumnNames
```
public String[] getElementColumnNames(String alias)
```
    Description copied from interface: QueryableCollection
    
    Get the names of the collection element columns (or the primary key columns in the case of a one-to-many association), aliased by the given table alias
    
    Specified by:
    
    getElementColumnNames in interface QueryableCollection
  - getElementColumnNames
```
public String[] getElementColumnNames()
```
    Description copied from interface: QueryableCollection
    
    Get the names of the collection element columns (or the primary key columns in the case of a one-to-many association)
    
    Specified by:
    
    getElementColumnNames in interface QueryableCollection
  - getKeyColumnNames
```
public String[] getKeyColumnNames()
```
    Description copied from interface: Joinable
    
    The columns to join on
    
    Specified by:
    
    getKeyColumnNames in interface Joinable
  - hasIndex
```
public boolean hasIndex()
```
    Description copied from interface: CollectionPersister
    
    Is this an "indexed" collection? (list or map)
    
    Specified by:
    
    hasIndex in interface CollectionMetadata
    
    Specified by:
    
    hasIndex in interface CollectionPersister
  - isLazy
```
public boolean isLazy()
```
    Description copied from interface: CollectionPersister
    
    Is this collection lazily initialized?
    
    Specified by:
    
    isLazy in interface CollectionMetadata
    
    Specified by:
    
    isLazy in interface CollectionPersister
  - isInverse
```
public boolean isInverse()
```
    Description copied from interface: CollectionPersister
    
    Is this collection "inverse", so state changes are not propagated to the database.
    
    Specified by:
    
    isInverse in interface CollectionPersister
  - getTableName
```
public String getTableName()
```
    Description copied from interface: Joinable
    
    The table to join to.
    
    Specified by:
    
    getTableName in interface Joinable
  - remove
```
public void remove(Object id,
                   SharedSessionContractImplementor session)
            throws HibernateException
```
    Description copied from interface: CollectionPersister
    
    Completely remove the persistent state of the collection
    
    Specified by:
    
    remove in interface CollectionPersister
    
    Throws:
    
    HibernateException
  - isRowDeleteEnabled
```
protected boolean isRowDeleteEnabled()
```
  - needsRemove
```
public boolean needsRemove()
```
    Description copied from interface: CollectionPersister
    
    Whether CollectionPersister.remove(Object, SharedSessionContractImplementor) might actually do something, or if it is definitely a no-op.
    
    Specified by:
    
    needsRemove in interface CollectionPersister
  - isRowInsertEnabled
```
protected boolean isRowInsertEnabled()
```
  - getOwnerEntityName
```
public String getOwnerEntityName()
```
  - getOwnerEntityPersister
```
public EntityPersister getOwnerEntityPersister()
```
    Description copied from interface: CollectionPersister
    
    Get the persister of the entity that "owns" this collection
    
    Specified by:
    
    getOwnerEntityPersister in interface CollectionPersister
  - getIdentifierGenerator
```
@Deprecated
public IdentifierGenerator getIdentifierGenerator()
```
    Deprecated.
    
    Description copied from interface: CollectionPersister
    
    Get the surrogate key generation strategy (optional operation)
    
    Specified by:
    
    getIdentifierGenerator in interface CollectionPersister
  - getGenerator
```
public BeforeExecutionGenerator getGenerator()
```
    Description copied from interface: CollectionPersister
    
    Get the surrogate key generation strategy (optional operation)
    
    Specified by:
    
    getGenerator in interface CollectionPersister
  - hasOrphanDelete
```
public boolean hasOrphanDelete()
```
    Description copied from interface: CollectionPersister
    
    Does this collection implement "orphan delete"?
    
    Specified by:
    
    hasOrphanDelete in interface CollectionPersister
  - toType
```
public Type toType(String propertyName)
            throws QueryException
```
    Description copied from interface: PropertyMapping
    
    Given a component path expression, get the type of the property
    
    Specified by:
    
    toType in interface PropertyMapping
    
    Throws:
    
    QueryException
  - applyBaseRestrictions
```
public void applyBaseRestrictions(Consumer<Predicate> predicateConsumer,
                                  TableGroup tableGroup,
                                  boolean useQualifier,
                                  Map<String,Filter> enabledFilters,
                                  Set<String> treatAsDeclarations,
                                  SqlAstCreationState creationState)
```
    Description copied from interface: Restrictable
    
    Applies the base set of restrictions.
    
    Specified by:
    
    applyBaseRestrictions in interface Restrictable
  - applyWhereRestrictions
```
public void applyWhereRestrictions(Consumer<Predicate> predicateConsumer,
                                   TableGroup tableGroup,
                                   boolean useQualifier,
                                   SqlAstCreationState creationState)
```
    Description copied from interface: WhereRestrictable
    
    Apply the Where restrictions
    
    Specified by:
    
    applyWhereRestrictions in interface WhereRestrictable
  - applyWhereFragments
```
protected void applyWhereFragments(Consumer<Predicate> predicateConsumer,
                                   String alias,
                                   TableGroup tableGroup,
                                   SqlAstCreationState astCreationState)
```
  - applyFilterRestrictions
```
public void applyFilterRestrictions(Consumer<Predicate> predicateConsumer,
                                    TableGroup tableGroup,
                                    boolean useQualifier,
                                    Map<String,Filter> enabledFilters,
                                    SqlAstCreationState creationState)
```
    Description copied from interface: FilterRestrictable
    
    Applies just the Filter values enabled for the associated entity
    
    Specified by:
    
    applyFilterRestrictions in interface FilterRestrictable
  - isManyToMany
```
public abstract boolean isManyToMany()
```
    Description copied from interface: CollectionPersister
    
    Is this a many-to-many association? Note that this is mainly a convenience feature as the single persister does not contain all the information needed to handle a many-to-many itself, as internally it is looked at as two many-to-ones.
    
    Specified by:
    
    isManyToMany in interface CollectionPersister
  - applyBaseManyToManyRestrictions
```
public void applyBaseManyToManyRestrictions(Consumer<Predicate> predicateConsumer,
                                            TableGroup tableGroup,
                                            boolean useQualifier,
                                            Map<String,Filter> enabledFilters,
                                            Set<String> treatAsDeclarations,
                                            SqlAstCreationState creationState)
```
    Specified by:
    
    applyBaseManyToManyRestrictions in interface CollectionPersister
  - getManyToManyFilterFragment
```
public String getManyToManyFilterFragment(TableGroup tableGroup,
                                          Map<String,Filter> enabledFilters)
```
    Specified by:
    
    getManyToManyFilterFragment in interface CollectionPersister
  - toColumns
```
public String[] toColumns(String propertyName)
                   throws QueryException
```
    Description copied from interface: PropertyMapping
    
    Given a property path, return the corresponding column name(s).
    
    Specified by:
    
    toColumns in interface PropertyMapping
    
    Throws:
    
    QueryException
  - getName
```
public String getName()
```
    Description copied from interface: Joinable
    
    An identifying name; a class name or collection role name.
    
    Specified by:
    
    getName in interface Joinable
  - getElementPersister
```
public EntityPersister getElementPersister()
```
    Description copied from interface: QueryableCollection
    
    Get the persister of the element class, if this is a collection of entities (optional operation). Note that for a one-to-many association, the returned persister must be OuterJoinLoadable.
    
    Specified by:
    
    getElementPersister in interface QueryableCollection
  - getElementPersisterInternal
```
protected EntityPersister getElementPersisterInternal()
```
  - isCollection
```
public boolean isCollection()
```
    Description copied from interface: Joinable
    
    Is this instance actually a CollectionPersister?
    
    Specified by:
    
    isCollection in interface Joinable
  - getCollectionSpaces
```
public String[] getCollectionSpaces()
```
    Description copied from interface: CollectionPersister
    
    Get the "space" that holds the persistent state
    
    Specified by:
    
    getCollectionSpaces in interface CollectionPersister
  - processQueuedOps
```
public void processQueuedOps(PersistentCollection<?> collection,
                             Object key,
                             SharedSessionContractImplementor session)
```
    Description copied from interface: CollectionPersister
    
    Process queued operations within the PersistentCollection.
    
    Specified by:
    
    processQueuedOps in interface CollectionPersister
  - doProcessQueuedOps
```
protected abstract void doProcessQueuedOps(PersistentCollection<?> collection,
                                           Object key,
                                           SharedSessionContractImplementor session)
                                    throws HibernateException
```
    Throws:
    
    HibernateException
  - getCollectionMetadata
```
@Deprecated
public CollectionMetadata getCollectionMetadata()
```
    Deprecated.
    
    Description copied from interface: CollectionPersister
    
    Get the user-visible metadata for the collection (optional operation)
    
    Specified by:
    
    getCollectionMetadata in interface CollectionPersister
  - getFactory
```
public SessionFactoryImplementor getFactory()
```
    Specified by:
    
    getFactory in interface CollectionPersister
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isVersioned
```
public boolean isVersioned()
```
    Description copied from interface: CollectionPersister
    
    Does this collection cause version increment of the owning entity?
    
    Specified by:
    
    isVersioned in interface CollectionPersister
  - getSQLExceptionHelper
```
protected SqlExceptionHelper getSQLExceptionHelper()
```
  - getCacheEntryStructure
```
public CacheEntryStructure getCacheEntryStructure()
```
    Description copied from interface: CollectionPersister
    
    Get the structure used to store data into the collection's cache region
    
    Specified by:
    
    getCacheEntryStructure in interface CollectionPersister
  - isAffectedByEnabledFilters
```
public boolean isAffectedByEnabledFilters(SharedSessionContractImplementor session)
```
    Specified by:
    
    isAffectedByEnabledFilters in interface CollectionPersister
  - isSubselectLoadable
```
public boolean isSubselectLoadable()
```
  - isMutable
```
public boolean isMutable()
```
    Description copied from interface: CollectionPersister
    
    Can the elements of this collection change?
    
    Specified by:
    
    isMutable in interface CollectionPersister
  - getCollectionPropertyColumnAliases
```
public String[] getCollectionPropertyColumnAliases(String propertyName,
                                                   String suffix)
```
    Specified by:
    
    getCollectionPropertyColumnAliases in interface SQLLoadableCollection
  - initCollectionPropertyMap
```
public void initCollectionPropertyMap()
```
  - getSize
```
public int getSize(Object key,
                   SharedSessionContractImplementor session)
```
    Specified by:
    
    getSize in interface CollectionPersister
  - indexExists
```
public boolean indexExists(Object key,
                           Object index,
                           SharedSessionContractImplementor session)
```
    Specified by:
    
    indexExists in interface CollectionPersister
  - elementExists
```
public boolean elementExists(Object key,
                             Object element,
                             SharedSessionContractImplementor session)
```
    Specified by:
    
    elementExists in interface CollectionPersister
  - getElementByIndex
```
public Object getElementByIndex(Object key,
                                Object index,
                                SharedSessionContractImplementor session,
                                Object owner)
```
    Specified by:
    
    getElementByIndex in interface CollectionPersister
  - isExtraLazy
```
public boolean isExtraLazy()
```
    Specified by:
    
    isExtraLazy in interface CollectionPersister
  - getDialect
```
protected Dialect getDialect()
```
  - getBatchSize
```
public int getBatchSize()
```
    Specified by:
    
    getBatchSize in interface CollectionPersister
  - getMappedByProperty
```
public String getMappedByProperty()
```
    Specified by:
    
    getMappedByProperty in interface CollectionPersister
    
    Returns:
    
    the name of the property this collection is mapped by
  - getFilterAliasGenerator
```
public abstract FilterAliasGenerator getFilterAliasGenerator(String rootAlias)
```
  - getFilterAliasGenerator
```
public abstract FilterAliasGenerator getFilterAliasGenerator(TableGroup tableGroup)
```
  - injectAttributeMapping
```
public void injectAttributeMapping(PluralAttributeMapping attributeMapping)
```
    Allows injection of the corresponding plural-attribute mapping.
    
    Specified by:
    
    injectAttributeMapping in interface PluralAttributeMappingImpl.Aware
    
    Implementation Note:
    
    Helps solve the chicken-egg problem of which to create first. Ultimately we could make this work in a similar fashion to how this works in the relationship between EmbeddableMappingType and EmbeddableValuedModelPart.
  - getAttributeMapping
```
public PluralAttributeMapping getAttributeMapping()
```
    Specified by:
    
    getAttributeMapping in interface CollectionPersister
  - registerAffectingFetchProfile
```
public void registerAffectingFetchProfile(String fetchProfileName,
                                          Fetch.Style fetchStyle)
```
    Description copied from interface: FetchProfileAffectee
    
    Register the profile name with the entity/collection
    
    Specified by:
    
    registerAffectingFetchProfile in interface FetchProfileAffectee
  - isAffectedByEnabledFetchProfiles
```
public boolean isAffectedByEnabledFetchProfiles(LoadQueryInfluencers influencers)
```
    Specified by:
    
    isAffectedByEnabledFetchProfiles in interface CollectionPersister
  - isAffectedByEnabledFilters
```
public boolean isAffectedByEnabledFilters(LoadQueryInfluencers influencers)
```
    Specified by:
    
    isAffectedByEnabledFilters in interface CollectionPersister
  - isAffectedByEntityGraph
```
public boolean isAffectedByEntityGraph(LoadQueryInfluencers influencers)
```
    Specified by:
    
    isAffectedByEntityGraph in interface CollectionPersister
  - getCollectionSemantics
```
public CollectionSemantics<?,?> getCollectionSemantics()
```
    Specified by:
    
    getCollectionSemantics in interface CollectionPersister
  - getTargetPart
```
public PluralAttributeMapping getTargetPart()
```
    Description copied from interface: MutationTarget
    
    The ModelPart describing the mutation target
    
    Specified by:
    
    getTargetPart in interface CollectionMutationTarget
    
    Specified by:
    
    getTargetPart in interface MutationTarget<CollectionTableMapping>
  - getIdentifierTableName
```
public String getIdentifierTableName()
```
    Description copied from interface: MutationTarget
    
    The name of the table defining the identifier for this target
    
    Specified by:
    
    getIdentifierTableName in interface MutationTarget<CollectionTableMapping>
  - getCollectionTableMapping
```
public CollectionTableMapping getCollectionTableMapping()
```
    Specified by:
    
    getCollectionTableMapping in interface CollectionMutationTarget
  - hasPhysicalIndexColumn
```
public boolean hasPhysicalIndexColumn()
```
    Description copied from interface: CollectionMutationTarget
    
    Whether the collection has at least one physical index column
    
    Specified by:
    
    hasPhysicalIndexColumn in interface CollectionMutationTarget
  - forEachMutableTable
```
public void forEachMutableTable(Consumer<CollectionTableMapping> consumer)
```
    Description copied from interface: MutationTarget
    
    Visit each table.
    
    Specified by:
    
    forEachMutableTable in interface MutationTarget<CollectionTableMapping>
  - forEachMutableTableReverse
```
public void forEachMutableTableReverse(Consumer<CollectionTableMapping> consumer)
```
    Description copied from interface: MutationTarget
    
    Same as MutationTarget.forEachMutableTable(java.util.function.Consumer<T>) except that here the tables are visited in reverse order
    
    Specified by:
    
    forEachMutableTableReverse in interface MutationTarget<CollectionTableMapping>
  - buildDeleteAllOperation
```
protected JdbcMutationOperation buildDeleteAllOperation(MutatingTableReference tableReference)
```
  - generateDeleteAllAst
```
public RestrictedTableMutation<JdbcMutationOperation> generateDeleteAllAst(MutatingTableReference tableReference)
```
  - getCollectionType
```
public CollectionType getCollectionType()
```
    Description copied from interface: CollectionPersister
    
    Get the associated Type
    
    Specified by:
    
    getCollectionType in interface CollectionPersister
  - getKeyType
```
public Type getKeyType()
```
    Description copied from interface: CollectionPersister
    
    Get the "key" type (the type of the foreign key)
    
    Specified by:
    
    getKeyType in interface CollectionMetadata
    
    Specified by:
    
    getKeyType in interface CollectionPersister
  - getIdentifierType
```
public Type getIdentifierType()
```
    Description copied from interface: CollectionPersister
    
    Get the type of the surrogate key
    
    Specified by:
    
    getIdentifierType in interface CollectionPersister
  - getIndexType
```
public Type getIndexType()
```
    Description copied from interface: CollectionPersister
    
    Get the "index" type for a list or map (optional operation)
    
    Specified by:
    
    getIndexType in interface CollectionMetadata
    
    Specified by:
    
    getIndexType in interface CollectionPersister
  - getElementType
```
public Type getElementType()
```
    Description copied from interface: CollectionPersister
    
    Get the "element" type
    
    Specified by:
    
    getElementType in interface CollectionMetadata
    
    Specified by:
    
    getElementType in interface CollectionPersister
  - getKeyColumnAliases
```
public String[] getKeyColumnAliases(String suffix)
```
    Description copied from interface: CollectionPersister
    
    Generates the collection's key column aliases, based on the given suffix.
    
    Specified by:
    
    getKeyColumnAliases in interface CollectionPersister
    
    Parameters:
    
    suffix - The suffix to use in the key column alias generation.
    
    Returns:
    
    The key column aliases.
  - getElementColumnAliases
```
public String[] getElementColumnAliases(String suffix)
```
    Description copied from interface: CollectionPersister
    
    Generates the collection's element column aliases, based on the given suffix.
    
    Specified by:
    
    getElementColumnAliases in interface CollectionPersister
    
    Parameters:
    
    suffix - The suffix to use in the element column alias generation.
    
    Returns:
    
    The key column aliases.
  - getIndexColumnAliases
```
public String[] getIndexColumnAliases(String suffix)
```
    Description copied from interface: CollectionPersister
    
    Generates the collection's index column aliases, based on the given suffix.
    
    Specified by:
    
    getIndexColumnAliases in interface CollectionPersister
    
    Parameters:
    
    suffix - The suffix to use in the index column alias generation.
    
    Returns:
    
    The key column aliases, or null if not indexed.
  - getIdentifierColumnAlias
```
public String getIdentifierColumnAlias(String suffix)
```
    Description copied from interface: CollectionPersister
    
    Generates the collection's identifier column aliases, based on the given suffix.
    
    Specified by:
    
    getIdentifierColumnAlias in interface CollectionPersister
    
    Parameters:
    
    suffix - The suffix to use in the key column alias generation.
    
    Returns:
    
    The key column aliases.

Class AbstractCollectionPersister

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.persister.collection.mutation.CollectionMutationTarget

Methods inherited from interface org.hibernate.persister.collection.CollectionPersister

Methods inherited from interface org.hibernate.persister.collection.DeprecatedCollectionStuff

Methods inherited from interface org.hibernate.persister.entity.Joinable

Methods inherited from interface org.hibernate.sql.model.MutationTarget

Field Detail

qualifiedTableName

hasWhere

sqlWhereString

indexContainsFormula

elementIsPureFormula

keyColumnNames

indexColumnNames

indexFormulaTemplates

indexFormulas

indexColumnIsGettable

indexColumnIsSettable

elementColumnNames

elementColumnWriters

elementColumnReaders

elementColumnReaderTemplates

elementFormulaTemplates

elementFormulas

elementColumnIsGettable

elementColumnIsSettable

identifierColumnName

isInverse

batchSize

sqlExceptionHelper

elementType

keyColumnAliases

indexColumnAliases

elementColumnAliases

Constructor Detail

AbstractCollectionPersister

AbstractCollectionPersister

Method Detail

getNavigableRole

getSortingComparator

determineTableName

postInstantiate

logStaticSQL

initialize

getStandardCollectionLoader

determineLoaderToUse

createSubSelectLoader

createCollectionLoader

getCacheAccessStrategy

hasCache

getRowMutationOperations

getRemoveCoordinator

getSQLOrderByString

getManyToManyOrderByString

getFetchMode

hasOrdering

hasManyToManyOrdering

hasWhere

getElementClass

decrementIndexByBase

incrementIndexByBase

isPrimitiveArray

isArray

getIdentifierColumnName

selectFragment

generateSelectSizeString

generateDetectRowByIndexString

generateDetectRowByElementString

getIndexColumnNames

getIndexFormulas

getIndexColumnNames

getElementColumnNames

getElementColumnNames

getKeyColumnNames

hasIndex

isLazy