BasicCollectionPersister (hibernate-core JavaDocs)

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

All Implemented Interfaces:

CollectionMetadata, CollectionPersister, QueryableCollection, SQLLoadableCollection, Joinable, PropertyMapping, CollectionDefinition
```
public class BasicCollectionPersister
extends AbstractCollectionPersister
```
Collection persister for collections of values and many-to-many associations.

Field Summary
- Fields inherited from class org.hibernate.persister.collection.AbstractCollectionPersister
  batchSize, elementColumnAliases, elementColumnIsInPrimaryKey, elementColumnIsSettable, elementColumnNames, elementColumnReaders, elementColumnReaderTemplates, elementColumnWriters, elementFormulas, elementFormulaTemplates, elementIsPureFormula, elementType, hasIdentifier, hasIndex, hasWhere, identifierColumnName, indexColumnAliases, indexColumnIsGettable, indexColumnIsSettable, indexColumnNames, indexContainsFormula, indexFormulas, indexFormulaTemplates, isInverse, keyColumnAliases, keyColumnNames, qualifiedTableName, recreateBatchKey, sqlExceptionHelper, sqlWhereString

Constructor Summary

Constructors
Constructor and Description
`BasicCollectionPersister(Collection collectionBinding, CollectionDataAccess cacheAccessStrategy, PersisterCreationContext creationContext)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`consumesCollectionAlias()` Very, very, very ugly…
`boolean`	`consumesEntityAlias()` Very, very, very ugly…
`protected CollectionInitializer`	`createCollectionInitializer(LoadQueryInfluencers loadQueryInfluencers)` Create the <tt>CollectionLoader</tt>
`protected CollectionInitializer`	`createSubselectInitializer(SubselectFetch subselect, SharedSessionContractImplementor session)`
`protected void`	`doProcessQueuedOps(PersistentCollection collection, Serializable id, SharedSessionContractImplementor session)`
`protected int`	`doUpdateRows(Serializable id, PersistentCollection collection, SharedSessionContractImplementor session)`
`String`	`fromJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses)` Get the from clause part of any joins (optional operation)
`String`	`fromJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses, Set<String> treatAsDeclarations)` Get the from clause part of any joins (optional operation)
`protected String`	`generateDeleteRowString()` Generate the SQL DELETE that deletes a particular row
`protected String`	`generateDeleteString()` Generate the SQL DELETE that deletes all rows
`protected String`	`generateInsertRowString()` Generate the SQL INSERT that creates a new row
`protected String`	`generateUpdateRowString()` Generate the SQL UPDATE that updates a row
`org.hibernate.internal.FilterAliasGenerator`	`getFilterAliasGenerator(String rootAlias)`
`boolean`	`isCascadeDeleteEnabled()` Is cascade delete handled by the database-level foreign key constraint definition?
`boolean`	`isManyToMany()` Is this a many-to-many association? Note that this is mainly a convenience feature as the single persister does not conatin all the information needed to handle a many-to-many itself, as internally it is looked at as two many-to-ones.
`boolean`	`isOneToMany()` Is this a one-to-many association?
`String`	`selectFragment(Joinable rhs, String rhsAlias, String lhsAlias, String entitySuffix, String collectionSuffix, boolean includeCollectionColumns)` All columns to select, when loading.
`String`	`whereJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses)` Get the where clause part of any joins (optional operation)
`String`	`whereJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses, Set<String> treatAsDeclarations)` Get the where clause part of any joins (optional operation)

Methods inherited from class org.hibernate.persister.collection.AbstractCollectionPersister
appendElementColumns, appendIdentifierColumns, appendIndexColumns, decrementIndexByBase, deleteRows, determineTableName, doProcessQueuedOps, elementExists, filterFragment, filterFragment, filterFragment, filterFragment, generateDetectRowByElementString, generateDetectRowByIndexString, generateSelectFragment, generateSelectRowByIndexString, generateSelectSizeString, getAppropriateInitializer, getBatchSize, getCacheAccessStrategy, getCacheEntryStructure, getCollectionMetadata, getCollectionPersister, getCollectionPropertyColumnAliases, getCollectionSpaces, getCollectionType, getDeleteAllCheckStyle, getDeleteCheckStyle, getDialect, getElementByIndex, getElementClass, getElementColumnAliases, getElementColumnNames, getElementColumnNames, getElementDefinition, getElementPersister, getElementType, getFactory, getFetchMode, getIdentifierColumnAlias, getIdentifierColumnName, getIdentifierGenerator, getIdentifierType, getIndexColumnAliases, getIndexColumnNames, getIndexColumnNames, getIndexDefinition, getIndexFormulas, getIndexType, getInitializer, getInsertCheckStyle, getKeyColumnAliases, getKeyColumnNames, getKeyType, getManyToManyFilterFragment, getManyToManyOrderByString, getMappedByProperty, getName, getNavigableRole, getOwnerEntityName, getOwnerEntityPersister, getRole, getSize, getSQLDeleteRowString, getSQLDeleteString, getSQLExceptionConverter, getSQLExceptionHelper, getSQLInsertRowString, getSQLOrderByString, getSQLUpdateRowString, getSQLWhereString, getTableName, getType, getUpdateCheckStyle, hasCache, hasIndex, hasManyToManyOrdering, hasOrdering, hasOrphanDelete, hasWhere, incrementIndexByBase, indexExists, initCollectionPropertyMap, initialize, insertRows, isAffectedByEnabledFilters, isArray, isCollection, isDeleteAllCallable, isDeleteCallable, isExtraLazy, isInsertCallable, isInverse, isLazy, isMutable, isPrimitiveArray, isRowDeleteEnabled, isRowInsertEnabled, isSubselectLoadable, isUpdateCallable, isVersioned, logStaticSQL, oneToManyFilterFragment, oneToManyFilterFragment, postInstantiate, processQueuedOps, readElement, readIdentifier, readIndex, readKey, recreate, remove, selectFragment, toColumns, toColumns, toString, toType, updateRows, writeElement, writeElementToWhere, writeIdentifier, writeIndex, writeIndexToWhere, writeKey

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

Constructor Detail

BasicCollectionPersister

public BasicCollectionPersister(Collection collectionBinding,
                                CollectionDataAccess cacheAccessStrategy,
                                PersisterCreationContext creationContext)
                         throws MappingException,
                                CacheException

Throws:: MappingException; CacheException

Method Detail

isCascadeDeleteEnabled
```
public boolean isCascadeDeleteEnabled()
```
Description copied from interface: CollectionPersister

Is cascade delete handled by the database-level foreign key constraint definition?

generateDeleteString
```
protected String generateDeleteString()
```
Generate the SQL DELETE that deletes all rows

Specified by:

generateDeleteString in class AbstractCollectionPersister

generateInsertRowString
```
protected String generateInsertRowString()
```
Generate the SQL INSERT that creates a new row

Specified by:

generateInsertRowString in class AbstractCollectionPersister

generateUpdateRowString
```
protected String generateUpdateRowString()
```
Generate the SQL UPDATE that updates a row

Specified by:

generateUpdateRowString in class AbstractCollectionPersister

doProcessQueuedOps

protected void doProcessQueuedOps(PersistentCollection collection,
                                  Serializable id,
                                  SharedSessionContractImplementor session)

Specified by:: doProcessQueuedOps in class AbstractCollectionPersister

generateDeleteRowString
```
protected String generateDeleteRowString()
```
Generate the SQL DELETE that deletes a particular row

Specified by:

generateDeleteRowString in class AbstractCollectionPersister

consumesEntityAlias
```
public boolean consumesEntityAlias()
```
Description copied from interface: Joinable

Very, very, very ugly…

Returns:

Does this persister "consume" entity column aliases in the result set?

consumesCollectionAlias
```
public boolean consumesCollectionAlias()
```
Description copied from interface: Joinable

Very, very, very ugly…

Returns:

Does this persister "consume" collection column aliases in the result set?

isOneToMany
```
public boolean isOneToMany()
```
Description copied from interface: CollectionPersister

Is this a one-to-many association?

isManyToMany
```
public 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 conatin 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

Specified by:

isManyToMany in class AbstractCollectionPersister

doUpdateRows

protected int doUpdateRows(Serializable id,
                           PersistentCollection collection,
                           SharedSessionContractImplementor session)
                    throws HibernateException

Specified by:: doUpdateRows in class AbstractCollectionPersister
Throws:: HibernateException