org.hibernate.type

Class CollectionType

Implemented Interfaces:
AssociationType, Serializable, Type
Known Direct Subclasses:
ArrayType, BagType, CustomCollectionType, IdentifierBagType, ListType, MapType, SetType

public abstract class CollectionType
extends AbstractType
implements AssociationType

A type that handles Hibernate PersistentCollections (including arrays).
Author:
Gavin King

Field Summary

static Object
UNFETCHED_COLLECTION

Constructor Summary

CollectionType(String role, String foreignKeyPropertyName, boolean isEmbeddedInXML)

Method Summary

Object
assemble(Serializable cached, SessionImplementor session, Object owner)
Reconstruct the object from its cached "disassembled" state.
int
compare(Object x, Object y, EntityMode entityMode)
compare two instances of the type
boolean
contains(Object collection, Object childObject, SessionImplementor session)
Object
deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections.
Serializable
disassemble(Object value, SessionImplementor session, Object owner)
Return a cacheable "disassembled" representation of the object.
Object
fromXMLNode(Node xml, Mapping factory)
Parse the XML representation of an instance.
String
getAssociatedEntityName(SessionFactoryImplementor factory)
Joinable
getAssociatedJoinable(SessionFactoryImplementor factory)
Object
getCollection(Serializable key, SessionImplementor session, Object owner)
instantiate a collection wrapper (called when loading an object)
int
getColumnSpan(Mapping session)
How many columns are used to persist this type.
Type
getElementType(SessionFactoryImplementor factory)
Get the Hibernate type of the collection elements
protected Iterator
getElementsIterator(Object collection)
Get an iterator over the element set of the collection in POJO mode
Iterator
getElementsIterator(Object collection, SessionImplementor session)
Get an iterator over the element set of the collection, which may not yet be wrapped
ForeignKeyDirection
getForeignKeyDirection()
int
getHashCode(Object x, EntityMode entityMode)
Get a hashcode, consistent with persistence "equality"
Serializable
getIdOfOwnerOrNull(Serializable key, SessionImplementor session)
Get the id value from the owning entity key, usually the same as the key, but might be some other property, in the case of property-ref
Serializable
getKeyOfOwner(Object owner, SessionImplementor session)
Get the key value from the owning entity instance, usually the identifier, but might be some other unique key, in the case of property-ref
String
getLHSPropertyName()
String
getName()
Returns the abbreviated name of the type.
String
getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters)
String
getRHSUniqueKeyPropertyName()
String
getRole()
boolean
hasHolder(EntityMode entityMode)
Object
hydrate(ResultSet rs, String[] name, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset.
Object
indexOf(Object collection, Object element)
protected boolean
initializeImmediately(EntityMode entityMode)
abstract Object
instantiate(int anticipatedSize)
Instantiate an empty instance of the "underlying" collection (not a wrapper), but with the given anticipated size (i.e.
abstract PersistentCollection
instantiate(SessionImplementor session, CollectionPersister persister, Serializable key)
Instantiate an uninitialized collection wrapper or holder.
protected Object
instantiateResult(Object original)
Instantiate a new "underlying" collection exhibiting the same capacity charactersitcs and the passed "original".
boolean
isAlwaysDirtyChecked()
We always need to dirty check the collection because we sometimes need to incremement version number of owner and also because of how assemble/disassemble is implemented for uks
boolean
isArrayType()
boolean
isAssociationType()
Note: return true because this type is castable to AssociationType.
boolean
isCollectionType()
Is this type a collection type.
boolean
isDirty(Object old, Object current, boolean[] checkable, SessionImplementor session)
Should the parent be considered dirty, given both the old and current field or element value?
boolean
isDirty(Object old, Object current, SessionImplementor session)
Should the parent be considered dirty, given both the old and current field or element value?
boolean
isEmbeddedInXML()
boolean
isEqual(Object x, Object y, EntityMode entityMode)
Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state.
boolean
isModified(Object old, Object current, boolean[] checkable, SessionImplementor session)
Has the parent object been modified, compared to the current database state?
boolean
isMutable()
Are objects of this type mutable.
boolean
isXMLElement()
Object
nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class from a JDBC resultset.
Object
nullSafeGet(ResultSet rs, String[] name, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class from a JDBC resultset.
void
nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session)
Write an instance of the mapped class to a prepared statement, ignoring some columns.
void
nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session)
Write an instance of the mapped class to a prepared statement.
protected String
renderLoggableString(Object value, SessionFactoryImplementor factory)
Object
replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache)
Object
replaceElements(Object original, Object target, Object owner, Map copyCache, SessionImplementor session)
Replace the elements of a collection with the elements of another collection.
Object
resolve(Object value, SessionImplementor session, Object owner)
Map identifiers to entities or collections.
Object
semiResolve(Object value, SessionImplementor session, Object owner)
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
void
setToXMLNode(Node node, Object value, SessionFactoryImplementor factory)
A representation of the value to be embedded in an XML element.
int[]
sqlTypes(Mapping session)
Return the SQL type codes for the columns mapped by this type.
boolean[]
toColumnNullness(Object value, Mapping mapping)
Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
String
toLoggableString(Object value, SessionFactoryImplementor factory)
A representation of the value to be embedded in a log file.
String
toString()
boolean
useLHSPrimaryKey()
abstract PersistentCollection
wrap(SessionImplementor session, Object collection)
Wrap the naked collection instance in a wrapper, or instantiate a holder.

Methods inherited from class org.hibernate.type.AbstractType

assemble, beforeAssemble, compare, disassemble, getHashCode, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isEqual, isModified, isSame, isXMLElement, replace, replaceNode, resolve, semiResolve

Field Details

UNFETCHED_COLLECTION

public static final Object UNFETCHED_COLLECTION

Constructor Details

CollectionType

public CollectionType(String role,
                      String foreignKeyPropertyName,
                      boolean isEmbeddedInXML)

Method Details

assemble

public Object assemble(Serializable cached,
                       SessionImplementor session,
                       Object owner)
            throws HibernateException
Reconstruct the object from its cached "disassembled" state.
Specified by:
assemble in interface Type
Overrides:
assemble in interface AbstractType
Parameters:
cached - the disassembled state from the cache
session - the session
owner - the parent entity object
Returns:
the the object

compare

public int compare(Object x,
                   Object y,
                   EntityMode entityMode)
compare two instances of the type
Specified by:
compare in interface Type
Overrides:
compare in interface AbstractType
Parameters:
entityMode -

contains

public boolean contains(Object collection,
                        Object childObject,
                        SessionImplementor session)

deepCopy

public Object deepCopy(Object value,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
            throws HibernateException
Return a deep copy of the persistent state, stopping at entities and at collections.
Specified by:
deepCopy in interface Type
Parameters:
value - generally a collection element or entity field
entityMode -
factory -
Returns:
Object a copy

disassemble

public Serializable disassemble(Object value,
                                SessionImplementor session,
                                Object owner)
            throws HibernateException
Return a cacheable "disassembled" representation of the object.
Specified by:
disassemble in interface Type
Overrides:
disassemble in interface AbstractType
Parameters:
value - the value to cache
session - the session
owner - optional parent entity object (needed for collections)
Returns:
the disassembled, deep cloned state

fromXMLNode

public Object fromXMLNode(Node xml,
                          Mapping factory)
            throws HibernateException
Parse the XML representation of an instance.
Specified by:
fromXMLNode in interface Type
Parameters:
xml -
factory -
Returns:
an instance of the type

getAssociatedEntityName

public String getAssociatedEntityName(SessionFactoryImplementor factory)
            throws MappingException
Specified by:
getAssociatedEntityName in interface AssociationType

getAssociatedJoinable

public Joinable getAssociatedJoinable(SessionFactoryImplementor factory)
            throws MappingException
Specified by:
getAssociatedJoinable in interface AssociationType

getCollection

public Object getCollection(Serializable key,
                            SessionImplementor session,
                            Object owner)
instantiate a collection wrapper (called when loading an object)
Parameters:
key - The collection owner key
session - The session from which the request is originating.
owner - The collection owner
Returns:
The collection

getColumnSpan

public int getColumnSpan(Mapping session)
            throws MappingException
How many columns are used to persist this type.
Specified by:
getColumnSpan in interface Type

getElementType

public final Type getElementType(SessionFactoryImplementor factory)
            throws MappingException
Get the Hibernate type of the collection elements
Parameters:
factory - The session factory.
Returns:
The type of the collection elements
Throws:
MappingException - Indicates the underlying persister could not be located.

getElementsIterator

protected Iterator getElementsIterator(Object collection)
Get an iterator over the element set of the collection in POJO mode
Parameters:
collection - The collection to be iterated
Returns:
The iterator.

getElementsIterator

public Iterator getElementsIterator(Object collection,
                                    SessionImplementor session)
Get an iterator over the element set of the collection, which may not yet be wrapped
Parameters:
collection - The collection to be iterated
session - The session from which the request is originating.
Returns:
The iterator.

getForeignKeyDirection

public ForeignKeyDirection getForeignKeyDirection()
Specified by:
getForeignKeyDirection in interface AssociationType

getHashCode

public int getHashCode(Object x,
                       EntityMode entityMode)
Get a hashcode, consistent with persistence "equality"
Specified by:
getHashCode in interface Type
Overrides:
getHashCode in interface AbstractType
Parameters:
x -
entityMode -

getIdOfOwnerOrNull

public Serializable getIdOfOwnerOrNull(Serializable key,
                                       SessionImplementor session)
Get the id value from the owning entity key, usually the same as the key, but might be some other property, in the case of property-ref
Parameters:
key - The collection owner key
session - The session from which the request is originating.
Returns:
The collection owner's id, if it can be obtained from the key; otherwise, null is returned

getKeyOfOwner

public Serializable getKeyOfOwner(Object owner,
                                  SessionImplementor session)
Get the key value from the owning entity instance, usually the identifier, but might be some other unique key, in the case of property-ref
Parameters:
owner - The collection owner
session - The session from which the request is originating.
Returns:
The collection owner's key

getLHSPropertyName

public String getLHSPropertyName()
Specified by:
getLHSPropertyName in interface AssociationType

getName

public String getName()
Returns the abbreviated name of the type.
Specified by:
getName in interface Type
Returns:
String the Hibernate type name

getOnCondition

public String getOnCondition(String alias,
                             SessionFactoryImplementor factory,
                             Map enabledFilters)
            throws MappingException
Specified by:
getOnCondition in interface AssociationType

getRHSUniqueKeyPropertyName

public String getRHSUniqueKeyPropertyName()
Specified by:
getRHSUniqueKeyPropertyName in interface AssociationType

getRole

public String getRole()

hasHolder

public boolean hasHolder(EntityMode entityMode)

hydrate

public Object hydrate(ResultSet rs,
                      String[] name,
                      SessionImplementor session,
                      Object owner)
Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. This is useful for 2-phase property initialization - the second phase is a call to resolveIdentifier().
Specified by:
hydrate in interface Type
Overrides:
hydrate in interface AbstractType
Parameters:
rs -
session - the session
owner - the parent entity
Returns:
Object an identifier or actual value

indexOf

public Object indexOf(Object collection,
                      Object element)

initializeImmediately

protected boolean initializeImmediately(EntityMode entityMode)

instantiate

public abstract Object instantiate(int anticipatedSize)
Instantiate an empty instance of the "underlying" collection (not a wrapper), but with the given anticipated size (i.e. accounting for initial capacity and perhaps load factor).
Parameters:
anticipatedSize - The anticipated size of the instaniated collection after we are done populating it.
Returns:
A newly instantiated collection to be wrapped.

instantiate

public abstract PersistentCollection instantiate(SessionImplementor session,
                                                 CollectionPersister persister,
                                                 Serializable key)
Instantiate an uninitialized collection wrapper or holder. Callers MUST add the holder to the persistence context!
Parameters:
session - The session from which the request is originating.
persister - The underlying collection persister (metadata)
key - The owner key.
Returns:
The instantiated collection.

instantiateResult

protected Object instantiateResult(Object original)
Instantiate a new "underlying" collection exhibiting the same capacity charactersitcs and the passed "original".
Parameters:
original - The original collection.
Returns:
The newly instantiated collection.

isAlwaysDirtyChecked

public boolean isAlwaysDirtyChecked()
We always need to dirty check the collection because we sometimes need to incremement version number of owner and also because of how assemble/disassemble is implemented for uks
Specified by:
isAlwaysDirtyChecked in interface AssociationType

isArrayType

public boolean isArrayType()

isAssociationType

public boolean isAssociationType()
Note: return true because this type is castable to AssociationType. Not because all collections are associations.
Specified by:
isAssociationType in interface Type
Overrides:
isAssociationType in interface AbstractType

isCollectionType

public boolean isCollectionType()
Is this type a collection type.
Specified by:
isCollectionType in interface Type
Overrides:
isCollectionType in interface AbstractType

isDirty

public boolean isDirty(Object old,
                       Object current,
                       boolean[] checkable,
                       SessionImplementor session)
            throws HibernateException
Should the parent be considered dirty, given both the old and current field or element value?
Specified by:
isDirty in interface Type
Parameters:
old - the old value
current - the current value
checkable - which columns are actually updatable
session -
Returns:
true if the field is dirty

isDirty

public boolean isDirty(Object old,
                       Object current,
                       SessionImplementor session)
            throws HibernateException
Should the parent be considered dirty, given both the old and current field or element value?
Specified by:
isDirty in interface Type
Overrides:
isDirty in interface AbstractType
Parameters:
old - the old value
current - the current value
session -
Returns:
true if the field is dirty

isEmbeddedInXML

public boolean isEmbeddedInXML()
Specified by:
isEmbeddedInXML in interface AssociationType

isEqual

public final boolean isEqual(Object x,
                             Object y,
                             EntityMode entityMode)
Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state.
Specified by:
isEqual in interface Type
Overrides:
isEqual in interface AbstractType
Parameters:
x -
y -
entityMode -
Returns:
boolean

isModified

public boolean isModified(Object old,
                          Object current,
                          boolean[] checkable,
                          SessionImplementor session)
            throws HibernateException
Has the parent object been modified, compared to the current database state?
Specified by:
isModified in interface Type
Overrides:
isModified in interface AbstractType
Parameters:
checkable - which columns are actually updatable
session -
Returns:
true if the field has been modified

isMutable

public boolean isMutable()
Are objects of this type mutable. (With respect to the referencing object ... entities and collections are considered immutable because they manage their own internal state.)
Specified by:
isMutable in interface Type
Returns:
boolean

isXMLElement

public boolean isXMLElement()
Specified by:
isXMLElement in interface Type
Overrides:
isXMLElement in interface AbstractType

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String name,
                          SessionImplementor session,
                          Object owner)
            throws SQLException
Retrieve an instance of the mapped class from a JDBC resultset. Implementations should handle possibility of null values. This method might be called if the type is known to be a single-column type.
Specified by:
nullSafeGet in interface Type
Parameters:
rs -
name - the column name
session -
owner - the parent entity
Returns:
Object

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String[] name,
                          SessionImplementor session,
                          Object owner)
            throws HibernateException,
                   SQLException
Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.
Specified by:
nullSafeGet in interface Type
Parameters:
rs -
session -
owner - the parent entity
Returns:
Object

nullSafeSet

public final void nullSafeSet(PreparedStatement st,
                              Object value,
                              int index,
                              boolean[] settable,
                              SessionImplementor session)
            throws HibernateException,
                   SQLException
Write an instance of the mapped class to a prepared statement, ignoring some columns. Implementors should handle possibility of null values. A multi-column type should be written to parameters starting from index.
Specified by:
nullSafeSet in interface Type
Parameters:
st -
value - the object to write
index - statement parameter index
settable - an array indicating which columns to ignore
session -

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        SessionImplementor session)
            throws HibernateException,
                   SQLException
Write an instance of the mapped class to a prepared statement. Implementors should handle possibility of null values. A multi-column type should be written to parameters starting from index.
Specified by:
nullSafeSet in interface Type
Parameters:
st -
value - the object to write
index - statement parameter index
session -

renderLoggableString

protected String renderLoggableString(Object value,
                                      SessionFactoryImplementor factory)
            throws HibernateException

replace

public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner,
                      Map copyCache)
            throws HibernateException
Specified by:
replace in interface Type

replaceElements

public Object replaceElements(Object original,
                              Object target,
                              Object owner,
                              Map copyCache,
                              SessionImplementor session)
Replace the elements of a collection with the elements of another collection.
Parameters:
original - The 'source' of the replacement elements (where we copy from)
target - The target of the replacement elements (where we copy to)
owner - The owner of the collection being merged
copyCache - The map of elements already replaced.
session - The session from which the merge event originated.
Returns:
The merged collection.

resolve

public Object resolve(Object value,
                      SessionImplementor session,
                      Object owner)
            throws HibernateException
Map identifiers to entities or collections. This is the second phase of 2-phase property initialization.
Specified by:
resolve in interface Type
Overrides:
resolve in interface AbstractType
Parameters:
value - an identifier or value returned by hydrate()
session - the session
owner - the parent entity
Returns:
the given value, or the value associated with the identifier

semiResolve

public Object semiResolve(Object value,
                          SessionImplementor session,
                          Object owner)
            throws HibernateException
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
Specified by:
semiResolve in interface Type
Overrides:
semiResolve in interface AbstractType

setToXMLNode

public void setToXMLNode(Node node,
                         Object value,
                         SessionFactoryImplementor factory)
            throws HibernateException
A representation of the value to be embedded in an XML element.
Specified by:
setToXMLNode in interface Type
Parameters:
value -
factory -

sqlTypes

public int[] sqlTypes(Mapping session)
            throws MappingException
Return the SQL type codes for the columns mapped by this type. The codes are defined on java.sql.Types.
Specified by:
sqlTypes in interface Type
Returns:
the typecodes
See Also:
java.sql.Types

toColumnNullness

public boolean[] toColumnNullness(Object value,
                                  Mapping mapping)
Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
Specified by:
toColumnNullness in interface Type
Parameters:
value - an instance of the type

toLoggableString

public String toLoggableString(Object value,
                               SessionFactoryImplementor factory)
            throws HibernateException
A representation of the value to be embedded in a log file.
Specified by:
toLoggableString in interface Type
Parameters:
value -
factory -
Returns:
String

toString

public String toString()

useLHSPrimaryKey

public boolean useLHSPrimaryKey()
Specified by:
useLHSPrimaryKey in interface AssociationType

wrap

public abstract PersistentCollection wrap(SessionImplementor session,
                                          Object collection)
Wrap the naked collection instance in a wrapper, or instantiate a holder. Callers MUST add the holder to the persistence context!
Parameters:
session - The session from which the request is originating.
collection - The bare collection to be wrapped.
Returns:
The wrapped collection.