File Doc Category Size Date Package
CollectionPersister.java API Doc Hibernate 3.2.5 8416 Thu May 04 11:23:44 BST 2006 org.hibernate.persister.collection

CollectionPersister

public interface CollectionPersister

A strategy for persisting a collection role. Defines a contract between the persistence strategy and the actual persistent collection framework and session. Does not define operations that are required for querying collections, or loading by outer join.

Implements persistence of a collection instance while the instance is referenced in a particular role.

This class is highly coupled to the PersistentCollection hierarchy, since double dispatch is used to load and update collection elements.

May be considered an immutable view of the mapping object

see: QueryableCollection
see: PersistentCollection
author: Gavin King

Fields Summary
Constructors Summary
Methods Summary
public void deleteRows(org.hibernate.collection.PersistentCollection collection, java.io.Serializable key, org.hibernate.engine.SessionImplementor session)
Delete the persistent state of any elements that were removed from the collection
public boolean elementExists(java.io.Serializable key, java.lang.Object element, org.hibernate.engine.SessionImplementor session)
public org.hibernate.cache.CacheConcurrencyStrategy getCache()
Get the cache
public org.hibernate.cache.entry.CacheEntryStructure getCacheEntryStructure()
Get the cache structure
public org.hibernate.metadata.CollectionMetadata getCollectionMetadata()
public java.io.Serializable[] getCollectionSpaces()
Get the "space" that holds the persistent state
public org.hibernate.type.CollectionType getCollectionType()
Get the associated Type
public java.lang.Object getElementByIndex(java.io.Serializable key, java.lang.Object index, org.hibernate.engine.SessionImplementor session, java.lang.Object owner)
public java.lang.Class getElementClass()
Return the element class of an array, or null otherwise
public java.lang.String[] getElementColumnAliases(java.lang.String suffix)
Generates the collection's element column aliases, based on the given suffix.
param
suffix The suffix to use in the element column alias generation.
return
The key column aliases.
public java.lang.String getElementNodeName()
public org.hibernate.type.Type getElementType()
Get the "element" type
public org.hibernate.engine.SessionFactoryImplementor getFactory()
public java.lang.String getIdentifierColumnAlias(java.lang.String suffix)
Generates the collection's identifier column aliases, based on the given suffix.
param
suffix The suffix to use in the key column alias generation.
return
The key column aliases.
public org.hibernate.id.IdentifierGenerator getIdentifierGenerator()
Get the surrogate key generation strategy (optional operation)
public org.hibernate.type.Type getIdentifierType()
Get the type of the surrogate key
public java.lang.String[] getIndexColumnAliases(java.lang.String suffix)
Generates the collection's index column aliases, based on the given suffix.
param
suffix The suffix to use in the index column alias generation.
return
The key column aliases, or null if not indexed.
public java.lang.String getIndexNodeName()
public org.hibernate.type.Type getIndexType()
Get the "index" type for a list or map (optional operation)
public java.lang.String[] getKeyColumnAliases(java.lang.String suffix)
Generates the collection's key column aliases, based on the given suffix.
param
suffix The suffix to use in the key column alias generation.
return
The key column aliases.
public org.hibernate.type.Type getKeyType()
Get the "key" type (the type of the foreign key)
public java.lang.String getManyToManyFilterFragment(java.lang.String alias, java.util.Map enabledFilters)
public java.lang.String getNodeName()
public org.hibernate.persister.entity.EntityPersister getOwnerEntityPersister()
Get the persister of the entity that "owns" this collection
public java.lang.String getRole()
Get the name of this collection role (the fully qualified class name, extended by a "property path")
public int getSize(java.io.Serializable key, org.hibernate.engine.SessionImplementor session)
public boolean hasCache()
Is this collection role cacheable
public boolean hasIndex()
Is this an "indexed" collection? (list or map)
public boolean hasManyToManyOrdering()
public 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.)
public boolean hasOrphanDelete()
Does this collection implement "orphan delete"?
public boolean indexExists(java.io.Serializable key, java.lang.Object index, org.hibernate.engine.SessionImplementor session)
public void initialize(java.io.Serializable key, org.hibernate.engine.SessionImplementor session)
Initialize the given collection with the given key
public void insertRows(org.hibernate.collection.PersistentCollection collection, java.io.Serializable key, org.hibernate.engine.SessionImplementor session)
Insert the persistent state of any new collection elements
public boolean isAffectedByEnabledFilters(org.hibernate.engine.SessionImplementor session)
public boolean isArray()
Is this an array?
public abstract boolean isCascadeDeleteEnabled()
Is cascade delete handled by the database-level foreign key constraint definition?
public boolean isExtraLazy()
public boolean isInverse()
Is this collection "inverse", so state changes are not propogated to the database.
public boolean isLazy()
Is this collection lazyily initialized?
public 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.
public boolean isMutable()
Can the elements of this collection change?
public boolean isOneToMany()
Is this a one-to-many association?
public boolean isPrimitiveArray()
Is this an array or primitive values?
public boolean isVersioned()
Does this collection cause version increment of the owning entity?
public void postInstantiate()
public java.lang.Object readElement(java.sql.ResultSet rs, java.lang.Object owner, java.lang.String[] columnAliases, org.hibernate.engine.SessionImplementor session)
Read the element from a row of the JDBC ResultSet
public java.lang.Object readIdentifier(java.sql.ResultSet rs, java.lang.String columnAlias, org.hibernate.engine.SessionImplementor session)
Read the identifier from a row of the JDBC ResultSet
public java.lang.Object readIndex(java.sql.ResultSet rs, java.lang.String[] columnAliases, org.hibernate.engine.SessionImplementor session)
Read the index from a row of the JDBC ResultSet
public java.lang.Object readKey(java.sql.ResultSet rs, java.lang.String[] keyAliases, org.hibernate.engine.SessionImplementor session)
Read the key from a row of the JDBC ResultSet
public void recreate(org.hibernate.collection.PersistentCollection collection, java.io.Serializable key, org.hibernate.engine.SessionImplementor session)
(Re)create the collection's persistent state
public void remove(java.io.Serializable id, org.hibernate.engine.SessionImplementor session)
Completely remove the persistent state of the collection
public void updateRows(org.hibernate.collection.PersistentCollection collection, java.io.Serializable key, org.hibernate.engine.SessionImplementor session)
Update the persistent state of any elements that were modified