站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > Hibernate 3.2.3 正式版 API 英文文档

AbstractCollectionPersister (Hibernate API Documentation) - Hibernate 3.2.3 正式版 API 英文文档

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hibernate.persister.collection
Class AbstractCollectionPersister

java.lang.Object
  extended byorg.hibernate.persister.collection.AbstractCollectionPersister
All Implemented Interfaces:
CollectionMetadata, CollectionPersister, Joinable, PropertyMapping, QueryableCollection, SQLLoadableCollection
Direct Known Subclasses:
BasicCollectionPersister, OneToManyPersister
public abstract class AbstractCollectionPersister
extends Object
implements CollectionMetadata, SQLLoadableCollection

Base implementation of the QueryableCollection interface.

Author:
Gavin King
See Also:
BasicCollectionPersister, OneToManyPersister

Field Summary
protected  int batchSize
           
protected  String[] elementColumnAliases
           
protected  boolean[] elementColumnIsInPrimaryKey
           
protected  boolean[] elementColumnIsSettable
           
protected  String[] elementColumnNames
           
protected  String[] elementFormulas
           
protected  String[] elementFormulaTemplates
           
protected  boolean elementIsPureFormula
           
protected  Type elementType
           
protected  boolean hasIdentifier
           
protected  boolean hasIndex
           
protected  boolean hasWhere
           
protected  String identifierColumnName
           
protected  String[] indexColumnAliases
           
protected  boolean[] indexColumnIsSettable
           
protected  String[] indexColumnNames
           
protected  boolean indexContainsFormula
           
protected  String[] indexFormulas
           
protected  String[] indexFormulaTemplates
           
protected  String[] keyColumnAliases
           
protected  String[] keyColumnNames
           
protected  String qualifiedTableName
           
protected  String sqlWhereString
           
 
Constructor Summary
AbstractCollectionPersister(Collection collection, CacheConcurrencyStrategy cache, Configuration cfg, SessionFactoryImplementor factory)
           
 
Method Summary
protected  void appendElementColumns(SelectFragment frag, String elemAlias)
           
protected  void appendIdentifierColumns(SelectFragment frag, String alias)
           
protected  void appendIndexColumns(SelectFragment frag, String alias)
           
protected abstract  CollectionInitializer createCollectionInitializer(Map enabledFilters)
           
protected abstract  CollectionInitializer createSubselectInitializer(SubselectFetch subselect, SessionImplementor session)
           
protected  Object decrementIndexByBase(Object index)
           
 void deleteRows(PersistentCollection collection, Serializable id, SessionImplementor session)
          Delete the persistent state of any elements that were removed from the collection
protected abstract  int doUpdateRows(Serializable key, PersistentCollection collection, SessionImplementor session)
           
 boolean elementExists(Serializable key, Object element, SessionImplementor session)
           
protected  String filterFragment(String alias)
           
 String filterFragment(String alias, Map enabledFilters)
          Get the where clause filter, given a query alias and considering enabled session filters
protected abstract  String generateDeleteRowString()
           
protected abstract  String generateDeleteString()
           
protected  String generateDetectRowByElementString()
           
protected  String generateDetectRowByIndexString()
           
protected abstract  String generateInsertRowString()
           
protected  SelectFragment generateSelectFragment(String alias, String columnSuffix)
           
protected  String generateSelectRowByIndexString()
           
protected  String generateSelectSizeString(boolean isIntegerIndexed)
           
protected abstract  String generateUpdateRowString()
           
protected  CollectionInitializer getAppropriateInitializer(Serializable key, SessionImplementor session)
           
 CacheConcurrencyStrategy getCache()
          Get the cache
 CacheEntryStructure getCacheEntryStructure()
          Get the cache structure
 CollectionMetadata getCollectionMetadata()
           
 String[] getCollectionPropertyColumnAliases(String propertyName, String suffix)
           
 Serializable[] getCollectionSpaces()
          Get the "space" that holds the persistent state
 CollectionType getCollectionType()
          Get the associated Type
protected  ExecuteUpdateResultCheckStyle getDeleteAllCheckStyle()
           
protected  ExecuteUpdateResultCheckStyle getDeleteCheckStyle()
           
protected  Dialect getDialect()
           
 Object getElementByIndex(Serializable key, Object index, SessionImplementor 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
 String getElementNodeName()
           
 EntityPersister getElementPersister()
          Get the persister of the element class, if this is a collection of entities (optional operation).
 Type getElementType()
          The collection element type
 SessionFactoryImplementor getFactory()
           
 FetchMode getFetchMode()
          Should we load this collection role by outerjoining?
 String getIdentifierColumnAlias(String suffix)
          Generates the collection's identifier column aliases, based on the given suffix.
 String getIdentifierColumnName()
           
 IdentifierGenerator getIdentifierGenerator()
          Get the surrogate key generation strategy (optional operation)
 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)
 String getIndexNodeName()
           
 Type getIndexType()
          The collection index type (or null if the collection has no index)
protected  ExecuteUpdateResultCheckStyle getInsertCheckStyle()
           
 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()
          The collection key type
 String getManyToManyFilterFragment(String alias, Map enabledFilters)
           
 String getManyToManyOrderByString(String alias)
          Get the order-by to be applied at the target table of a many to many
 String getName()
          An identifying name; a class name or collection role name.
 String getNodeName()
           
 String getOwnerEntityName()
           
 EntityPersister getOwnerEntityPersister()
          Get the persister of the entity that "owns" this collection
 String getRole()
          The name of this collection role
 int getSize(Serializable key, SessionImplementor session)
           
protected  String getSQLDeleteRowString()
           
protected  String getSQLDeleteString()
           
protected  SQLExceptionConverter getSQLExceptionConverter()
           
protected  String getSQLInsertRowString()
           
 String getSQLOrderByString(String alias)
          Get the order by SQL
protected  String getSQLUpdateRowString()
           
protected  String getSQLWhereString(String alias)
           
 String getTableName()
          The table to join to.
 Type getType()
          Get the type of the thing containing the properties
protected  ExecuteUpdateResultCheckStyle getUpdateCheckStyle()
           
 boolean hasCache()
          Is this collection role cacheable
 boolean hasIndex()
          Is this collection indexed?
 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 hasWhere()
          Does this collection role have a where clause filter?
protected  Object incrementIndexByBase(Object index)
           
 boolean indexExists(Serializable key, Object index, SessionImplementor session)
           
 void initCollectionPropertyMap()
           
 void initialize(Serializable key, SessionImplementor session)
          Initialize the given collection with the given key
 void insertRows(PersistentCollection collection, Serializable id, SessionImplementor session)
          Insert the persistent state of any new collection elements
 boolean isAffectedByEnabledFilters(SessionImplementor session)
           
 boolean isArray()
          Is the collection an array?
 boolean isCollection()
          Is this instance actually a CollectionPersister?
protected  boolean isDeleteAllCallable()
           
protected  boolean isDeleteCallable()
           
 boolean isExtraLazy()
           
protected  boolean isInsertCallable()
           
 boolean isInverse()
          Is this collection "inverse", so state changes are not propogated to the database.
 boolean isLazy()
          Is the 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 conatin 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 the collection a primitive array?
protected  boolean isRowDeleteEnabled()
           
protected  boolean isRowInsertEnabled()
           
 boolean isSubselectLoadable()
           
protected  boolean isUpdateCallable()
           
 boolean isVersioned()
          Does this collection cause version increment of the owning entity?
protected  void logStaticSQL()
           
 String oneToManyFilterFragment(String alias)
           
 void postInstantiate()
           
 Object readElement(ResultSet rs, Object owner, String[] aliases, SessionImplementor session)
          Read the element from a row of the JDBC ResultSet
 Object readIdentifier(ResultSet rs, String alias, SessionImplementor session)
          Read the identifier from a row of the JDBC ResultSet
 Object readIndex(ResultSet rs, String[] aliases, SessionImplementor session)
          Read the index from a row of the JDBC ResultSet
 Object readKey(ResultSet rs, String[] aliases, SessionImplementor session)
          Read the key from a row of the JDBC ResultSet
 void recreate(PersistentCollection collection, Serializable id, SessionImplementor session)
          (Re)create the collection's persistent state
 void remove(Serializable id, SessionImplementor 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[] toColumns(String alias, String propertyName)
          Given a query alias and a property path, return the qualified column name
 String toString()
           
 Type toType(String propertyName)
          Given a component path expression, get the type of the property
 void updateRows(PersistentCollection collection, Serializable id, SessionImplementor session)
          Update the persistent state of any elements that were modified
protected  int writeElement(PreparedStatement st, Object elt, int i, SessionImplementor session)
          Write the element to a JDBC PreparedStatement
protected  int writeElementToWhere(PreparedStatement st, Object elt, int i, SessionImplementor session)
          Write the element to a JDBC PreparedStatement
 int writeIdentifier(PreparedStatement st, Object id, int i, SessionImplementor session)
          Write the identifier to a JDBC PreparedStatement
protected  int writeIndex(PreparedStatement st, Object index, int i, SessionImplementor session)
          Write the index to a JDBC PreparedStatement
protected  int writeIndexToWhere(PreparedStatement st, Object index, int i, SessionImplementor session)
          Write the index to a JDBC PreparedStatement
protected  int writeKey(PreparedStatement st, Serializable key, int i, SessionImplementor session)
          Write the key to a JDBC PreparedStatement
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.hibernate.persister.entity.Joinable
consumesCollectionAlias, consumesEntityAlias, fromJoinFragment, selectFragment, whereJoinFragment
 
Methods inherited from interface org.hibernate.persister.collection.CollectionPersister
isCascadeDeleteEnabled, isOneToMany
 

Field Detail

sqlWhereString

protected final String sqlWhereString

hasWhere

protected final boolean hasWhere

indexContainsFormula

protected final boolean indexContainsFormula

elementIsPureFormula

protected final boolean elementIsPureFormula

elementType

protected final Type elementType

keyColumnNames

protected final String[] keyColumnNames

indexColumnNames

protected final String[] indexColumnNames

indexFormulaTemplates

protected final String[] indexFormulaTemplates

indexFormulas

protected final String[] indexFormulas

indexColumnIsSettable

protected final boolean[] indexColumnIsSettable

elementColumnNames

protected final String[] elementColumnNames

elementFormulaTemplates

protected final String[] elementFormulaTemplates

elementFormulas

protected final String[] elementFormulas

elementColumnIsSettable

protected final boolean[] elementColumnIsSettable

elementColumnIsInPrimaryKey

protected final boolean[] elementColumnIsInPrimaryKey

indexColumnAliases

protected final String[] indexColumnAliases

elementColumnAliases

protected final String[] elementColumnAliases

keyColumnAliases

protected final String[] keyColumnAliases

identifierColumnName

protected final String identifierColumnName

qualifiedTableName

protected final String qualifiedTableName

hasIndex

protected final boolean hasIndex

hasIdentifier

protected final boolean hasIdentifier

batchSize

protected final int batchSize
Constructor Detail

AbstractCollectionPersister

public AbstractCollectionPersister(Collection collection,
                                   CacheConcurrencyStrategy cache,
                                   Configuration cfg,
                                   SessionFactoryImplementor factory)
                            throws MappingException,
                                   CacheException
Method Detail

postInstantiate

public void postInstantiate()
                     throws MappingException
Specified by:
postInstantiate in interface CollectionPersister
Throws:
MappingException

logStaticSQL

protected void logStaticSQL()

initialize

public void initialize(Serializable key,
                       SessionImplementor session)
                throws HibernateException
Description copied from interface: CollectionPersister
Initialize the given collection with the given key

Specified by:
initialize in interface CollectionPersister
Throws:
HibernateException

getAppropriateInitializer

protected CollectionInitializer getAppropriateInitializer(Serializable key,
                                                          SessionImplementor session)

createSubselectInitializer

protected abstract CollectionInitializer createSubselectInitializer(SubselectFetch subselect,
                                                                    SessionImplementor session)

createCollectionInitializer

protected abstract CollectionInitializer createCollectionInitializer(Map enabledFilters)
                                                              throws MappingException
Throws:
MappingException

getCache

public CacheConcurrencyStrategy getCache()
Description copied from interface: CollectionPersister
Get the cache

Specified by:
getCache in interface CollectionPersister

hasCache

public boolean hasCache()
Description copied from interface: CollectionPersister
Is this collection role cacheable

Specified by:
hasCache in interface CollectionPersister

getCollectionType

public CollectionType getCollectionType()
Description copied from interface: CollectionPersister
Get the associated Type

Specified by:
getCollectionType in interface CollectionPersister

getSQLWhereString

protected String getSQLWhereString(String alias)

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

getSQLDeleteString

protected String getSQLDeleteString()

getSQLInsertRowString

protected String getSQLInsertRowString()

getSQLUpdateRowString

protected String getSQLUpdateRowString()

getSQLDeleteRowString

protected String getSQLDeleteRowString()

getKeyType

public Type getKeyType()
Description copied from interface: CollectionMetadata
The collection key type

Specified by:
getKeyType in interface CollectionMetadata

getIndexType

public Type getIndexType()
Description copied from interface: CollectionMetadata
The collection index type (or null if the collection has no index)

Specified by:
getIndexType in interface CollectionMetadata

getElementType

public Type getElementType()
Description copied from interface: CollectionMetadata
The collection element type

Specified by:
getElementType in interface CollectionMetadata

getElementClass

public Class getElementClass()
Return the element class of an array, or null otherwise

Specified by:
getElementClass</