public abstract class CollectionType extends AbstractType implements AssociationType
A type that handles Hibernate <tt>PersistentCollection</tt>s (including arrays).
Modifier and Type | Field and Description |
---|---|
static Object |
UNFETCHED_COLLECTION |
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE
Constructor and Description |
---|
CollectionType(TypeFactory.TypeScope typeScope,
String role,
String foreignKeyPropertyName) |
Modifier and Type | Method and Description |
---|---|
Object |
assemble(Serializable cached,
SharedSessionContractImplementor session,
Object owner)
Reconstruct the object from its disassembled state.
|
int |
compare(Object x,
Object y)
Perform a
Comparator style comparison between values |
boolean |
contains(Object collection,
Object childObject,
SharedSessionContractImplementor session) |
Object |
deepCopy(Object value,
SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections.
|
Size[] |
defaultSizes(Mapping mapping)
Defines the column sizes to use according to this type if the user did not explicitly say (and if no
Type.dictatedSizes(org.hibernate.engine.spi.Mapping) were given). |
Size[] |
dictatedSizes(Mapping mapping)
Return the column sizes dictated by this type.
|
Serializable |
disassemble(Object value,
SharedSessionContractImplementor session,
Object owner)
Return a disassembled representation of the object.
|
String |
getAssociatedEntityName(SessionFactoryImplementor factory)
Get the entity name of the associated entity
|
Joinable |
getAssociatedJoinable(SessionFactoryImplementor factory)
Get the "persister" for this association - a class or
collection persister
|
Object |
getCollection(Serializable key,
SharedSessionContractImplementor session,
Object owner,
Boolean overridingEager)
instantiate a collection wrapper (called when loading an object)
|
int |
getColumnSpan(Mapping session)
How many columns are used to persist this type.
|
protected Iterator |
getElementsIterator(Object collection)
Get an iterator over the element set of the collection in POJO mode
|
Iterator |
getElementsIterator(Object collection,
SharedSessionContractImplementor session)
Get an iterator over the element set of the collection, which may not yet be wrapped
|
Type |
getElementType(SessionFactoryImplementor factory)
Get the Hibernate type of the collection elements
|
ForeignKeyDirection |
getForeignKeyDirection()
Get the foreign key directionality of this association
|
int |
getHashCode(Object x)
Get a hash code, consistent with persistence "equality".
|
Serializable |
getIdOfOwnerOrNull(Serializable key,
SharedSessionContractImplementor 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,
SharedSessionContractImplementor 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()
Get the name of a property in the owning entity
that provides the join key (null if the identifier)
|
String |
getName()
Returns the abbreviated name of the type.
|
String |
getOnCondition(String alias,
SessionFactoryImplementor factory,
Map enabledFilters)
Get the "filtering" SQL fragment that is applied in the
SQL on clause, in addition to the usual join condition
|
String |
getOnCondition(String alias,
SessionFactoryImplementor factory,
Map enabledFilters,
Set<String> treatAsDeclarations)
Get the "filtering" SQL fragment that is applied in the
SQL on clause, in addition to the usual join condition
|
String |
getRHSUniqueKeyPropertyName()
The name of a unique property of the associated entity
that provides the join key (null if the identifier of
an entity, or key of a collection)
|
String |
getRole() |
boolean |
hasHolder() |
Object |
hydrate(ResultSet rs,
String[] name,
SharedSessionContractImplementor session,
Object owner)
Extract a value from the JDBC result set.
|
Object |
indexOf(Object collection,
Object element) |
protected boolean |
initializeImmediately() |
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(SharedSessionContractImplementor 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 <tt>AssociationType</tt>.
|
boolean |
isCollectionType()
Return true if the implementation is castable to
CollectionType . |
boolean |
isDirty(Object old,
Object current,
boolean[] checkable,
SharedSessionContractImplementor session)
Should the parent be considered dirty, given both the old and current value?
|
boolean |
isDirty(Object old,
Object current,
SharedSessionContractImplementor session)
Should the parent be considered dirty, given both the old and current value?
|
boolean |
isEqual(Object x,
Object y)
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,
SharedSessionContractImplementor session)
Has the value been modified compared to the current database state? The difference between this
and the
Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor) methods is that here we need to account for "partially" built values. |
boolean |
isMutable()
Are objects of this type mutable.
|
Object |
nullSafeGet(ResultSet rs,
String[] name,
SharedSessionContractImplementor session,
Object owner)
Extract a value of the
mapped class from the JDBC result set. |
Object |
nullSafeGet(ResultSet rs,
String name,
SharedSessionContractImplementor session,
Object owner)
Extract a value of the
mapped class from the JDBC result set. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
boolean[] settable,
SharedSessionContractImplementor session)
Bind a value represented by an instance of the
mapped class to the JDBC prepared
statement, ignoring some columns as dictated by the 'settable' parameter. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
SharedSessionContractImplementor session)
Bind a value represented by an instance of the
mapped class to the JDBC prepared
statement. |
protected String |
renderLoggableString(Object value,
SessionFactoryImplementor factory) |
Object |
replace(Object original,
Object target,
SharedSessionContractImplementor session,
Object owner,
Map copyCache)
During merge, replace the existing (target) value in the entity we are merging to
with a new (original) value from the detached entity we are merging.
|
Object |
replaceElements(Object original,
Object target,
Object owner,
Map copyCache,
SharedSessionContractImplementor session)
Replace the elements of a collection with the elements of another collection.
|
Object |
resolve(Object value,
SharedSessionContractImplementor session,
Object owner) |
Object |
resolve(Object value,
SharedSessionContractImplementor session,
Object owner,
Boolean overridingEager)
The second phase of 2-phase loading.
|
Object |
semiResolve(Object value,
SharedSessionContractImplementor session,
Object owner)
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref
associations.
|
int[] |
sqlTypes(Mapping session)
Return the JDBC types codes (per
Types ) 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)
Generate a representation of the value for logging purposes.
|
String |
toString() |
boolean |
useLHSPrimaryKey()
Is the primary key of the owning entity table
to be used in the join?
|
abstract PersistentCollection |
wrap(SharedSessionContractImplementor session,
Object collection)
Wrap the naked collection instance in a wrapper, or instantiate a
holder.
|
beforeAssemble, getHashCode, getSemiResolvedType, isAnyType, isComponentType, isEntityType, isEqual, isSame, replace
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
beforeAssemble, getHashCode, getReturnedClass, getSemiResolvedType, isAnyType, isComponentType, isEntityType, isEqual, isSame, replace
public static final Object UNFETCHED_COLLECTION
public CollectionType(TypeFactory.TypeScope typeScope, String role, String foreignKeyPropertyName)
public String getRole()
public boolean contains(Object collection, Object childObject, SharedSessionContractImplementor session)
public boolean isCollectionType()
Type
Return true if the implementation is castable to CollectionType
. Essentially a polymorphic version of
(type instanceof CollectionType.class)
<p/>
A CollectionType
is additionally an AssociationType
; so if this method returns true,
Type.isAssociationType()
should also return true.
isCollectionType
in interface Type
isCollectionType
in class AbstractType
CollectionType
implementor; false otherwise.public final boolean isEqual(Object x, Object y)
Type
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). <p/> This should always equate to some form of comparison of the value’s internal state. As an example, for something like a date the comparison should be based on its internal "time" state based on the specific portion it is meant to represent (timestamp, date, time).
isEqual
in interface Type
isEqual
in class AbstractType
x
- The first valuey
- The second valuepublic int compare(Object x, Object y)
Type
Perform a Comparator
style comparison between values
compare
in interface Type
compare
in class AbstractType
x
- The first valuey
- The second valueComparator.compare(T, T)
for a discussion.public int getHashCode(Object x)
Type
Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to
delegate to the value’s hashCode
.
getHashCode
in interface Type
getHashCode
in class AbstractType
x
- The value for which to retrieve a hash codepublic abstract PersistentCollection instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Serializable key)
Instantiate an uninitialized collection wrapper or holder. Callers MUST add the holder to the persistence context!
session
- The session from which the request is originating.persister
- The underlying collection persister (metadata)key
- The owner key.public Object nullSafeGet(ResultSet rs, String name, SharedSessionContractImplementor session, Object owner) throws SQLException
Type
Extract a value of the mapped class
from the JDBC result set. Implementors
should handle possibility of null values. This form might be called if the type is known to be a
single-column type.
nullSafeGet
in interface Type
rs
- The result set from which to extract value.name
- the column name making up this type value (use to read from result set)session
- The originating sessionowner
- the parent entitySQLException
- An error from the JDBC driverpublic Object nullSafeGet(ResultSet rs, String[] name, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
Type
Extract a value of the mapped class
from the JDBC result set. Implementors
should handle possibility of null values.
nullSafeGet
in interface Type
rs
- The result set from which to extract value.name
- the column names making up this type value (use to read from result set)session
- The originating sessionowner
- the parent entityHibernateException
- An error from HibernateSQLException
- An error from the JDBC driveralternative, 2-phase property initialization
public final void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session) throws HibernateException, SQLException
Type
Bind a value represented by an instance of the mapped class
to the JDBC prepared
statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the
possibility of null values. A multi-column type should bind parameters starting from <tt>index</tt>.
nullSafeSet
in interface Type
st
- The JDBC prepared statement to which to bindvalue
- the object to writeindex
- starting parameter bind indexsettable
- an array indicating which columns to bind/ignoresession
- The originating sessionHibernateException
- An error from HibernateSQLException
- An error from the JDBC driverpublic void nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session) throws HibernateException, SQLException
Type
Bind a value represented by an instance of the mapped class
to the JDBC prepared
statement. Implementors should handle possibility of null values. A multi-column type should bind parameters
starting from <tt>index</tt>.
nullSafeSet
in interface Type
st
- The JDBC prepared statement to which to bindvalue
- the object to writeindex
- starting parameter bind indexsession
- The originating sessionHibernateException
- An error from HibernateSQLException
- An error from the JDBC driverpublic int[] sqlTypes(Mapping session) throws MappingException
Type
Return the JDBC types codes (per Types
) for the columns mapped by this type.
<p/>
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping)
.
sqlTypes
in interface Type
session
- The mapping object :/MappingException
- Generally indicates an issue accessing the passed mapping object.public Size[] dictatedSizes(Mapping mapping) throws MappingException
Type
Return the column sizes dictated by this type. For example, the mapping for a char
/Character
would
have a dictated length limit of 1; for a string-based UUID
would have a size limit of 36; etc.
<p/>
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping)
.
dictatedSizes
in interface Type
mapping
- The mapping object :/MappingException
- Generally indicates an issue accessing the passed mapping object.public Size[] defaultSizes(Mapping mapping) throws MappingException
Type
Defines the column sizes to use according to this type if the user did not explicitly say (and if no
Type.dictatedSizes(org.hibernate.engine.spi.Mapping)
were given).
<p/>
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping)
.
defaultSizes
in interface Type
mapping
- The mapping object :/MappingException
- Generally indicates an issue accessing the passed mapping object.public int getColumnSpan(Mapping session) throws MappingException
Type
How many columns are used to persist this type. Always the same as sqlTypes(mapping).length
getColumnSpan
in interface Type
session
- The mapping object :/MappingException
- Generally indicates an issue accessing the passed mapping object.public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
Type
Generate a representation of the value for logging purposes.
toLoggableString
in interface Type
value
- The value to be loggedfactory
- The session factoryHibernateException
- An error from Hibernateprotected String renderLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
HibernateException
public Object deepCopy(Object value, SessionFactoryImplementor factory) throws HibernateException
Type
Return a deep copy of the persistent state, stopping at entities and at collections.
deepCopy
in interface Type
value
- The value to be copiedfactory
- The session factoryHibernateException
- An error from Hibernatepublic String getName()
Type
Returns the abbreviated name of the type.
public Iterator getElementsIterator(Object collection, SharedSessionContractImplementor session)
Get an iterator over the element set of the collection, which may not yet be wrapped
collection
- The collection to be iteratedsession
- The session from which the request is originating.protected Iterator getElementsIterator(Object collection)
Get an iterator over the element set of the collection in POJO mode
collection
- The collection to be iteratedpublic boolean isMutable()
Type
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.)
public Serializable disassemble(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
Type
Return a disassembled representation of the object. This is the value Hibernate will use in second level caching, so care should be taken to break values down to their simplest forms; for entities especially, this means breaking them down into their constituent parts.
disassemble
in interface Type
disassemble
in class AbstractType
value
- the value to cachesession
- the originating sessionowner
- optional parent entity object (needed for collections)HibernateException
- An error from Hibernatepublic Object assemble(Serializable cached, SharedSessionContractImplementor session, Object owner) throws HibernateException
Type
Reconstruct the object from its disassembled state. This method is the reciprocal of Type.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
assemble
in interface Type
assemble
in class AbstractType
cached
- the disassembled state from the cachesession
- the originating sessionowner
- the parent entity objectHibernateException
- An error from Hibernatepublic boolean isDirty(Object old, Object current, SharedSessionContractImplementor session) throws HibernateException
Type
Should the parent be considered dirty, given both the old and current value?
isDirty
in interface Type
isDirty
in class AbstractType
old
- the old valuecurrent
- the current valuesession
- The session from which the request originated.HibernateException
- A problem occurred performing the checkingpublic boolean isDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
Type
Should the parent be considered dirty, given both the old and current value?
isDirty
in interface Type
old
- the old valuecurrent
- the current valuecheckable
- An array of booleans indicating which columns making up the value are actually checkablesession
- The session from which the request originated.HibernateException
- A problem occurred performing the checkingpublic abstract PersistentCollection wrap(SharedSessionContractImplementor session, Object collection)
Wrap the naked collection instance in a wrapper, or instantiate a holder. Callers <b>MUST</b> add the holder to the persistence context!
session
- The session from which the request is originating.collection
- The bare collection to be wrapped.public boolean isAssociationType()
Note: return true because this type is castable to <tt>AssociationType</tt>. Not because all collections are associations.
isAssociationType
in interface Type
isAssociationType
in class AbstractType
AssociationType
implementor; false otherwise.public ForeignKeyDirection getForeignKeyDirection()
AssociationType
Get the foreign key directionality of this association
getForeignKeyDirection
in interface AssociationType
public Serializable getKeyOfOwner(Object owner, SharedSessionContractImplementor 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
owner
- The collection ownersession
- The session from which the request is originating.public Serializable getIdOfOwnerOrNull(Serializable key, SharedSessionContractImplementor 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
key
- The collection owner keysession
- The session from which the request is originating.public Object hydrate(ResultSet rs, String[] name, SharedSessionContractImplementor session, Object owner)
Type
Extract a value from the JDBC result set. This is useful for 2-phase property initialization - the second
phase is a call to Type.resolve(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
This hydrated value will be either:<ul>
<li>in the case of an entity or collection type, the key</li>
<li>otherwise, the value itself</li>
</ul>
hydrate
in interface Type
hydrate
in class AbstractType
rs
- The JDBC result setname
- the column names making up this type value (use to read from result set)session
- The originating sessionowner
- the parent entityType.resolve(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
public Object resolve(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
resolve
in interface Type
resolve
in class AbstractType
HibernateException
Type.resolve(Object, SharedSessionContractImplementor, Object, Boolean)
public Object resolve(Object value, SharedSessionContractImplementor session, Object owner, Boolean overridingEager) throws HibernateException
Type
The second phase of 2-phase loading. Only really pertinent for entities and collections. Here we resolve the identifier to an entity or collection instance
resolve
in interface Type
value
- an identifier or value returned by <tt>hydrate()</tt>session
- the sessionowner
- the parent entityoverridingEager
- can override eager from the mapping. For example because of LoadQueryInfluencers
If null, then it does not override. If true or false then it overrides the mapping value.HibernateException
- An error from HibernateType.hydrate(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
public Object semiResolve(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
Type
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
semiResolve
in interface Type
semiResolve
in class AbstractType
value
- The unresolved, hydrated valuesession
- THe originating sessionowner
- The value ownerHibernateException
- An error from Hibernatepublic boolean isArrayType()
public boolean useLHSPrimaryKey()
AssociationType
Is the primary key of the owning entity table to be used in the join?
useLHSPrimaryKey
in interface AssociationType
public String getRHSUniqueKeyPropertyName()
AssociationType
The name of a unique property of the associated entity that provides the join key (null if the identifier of an entity, or key of a collection)
getRHSUniqueKeyPropertyName
in interface AssociationType
public Joinable getAssociatedJoinable(SessionFactoryImplementor factory) throws MappingException
AssociationType
Get the "persister" for this association - a class or collection persister
getAssociatedJoinable
in interface AssociationType
MappingException
public boolean isModified(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
Type
Has the value been modified compared to the current database state? The difference between this
and the Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)
methods is that here we need to account for "partially" built values. This is really
only an issue with association types. For most type implementations it is enough to simply delegate to
Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)
here/
isModified
in interface Type
isModified
in class AbstractType
old
- the database state, in a "hydrated" form, with identifiers unresolvedcurrent
- the current state of the objectcheckable
- which columns are actually updatablesession
- The session from which the request originated.HibernateException
- A problem occurred performing the checkingpublic String getAssociatedEntityName(SessionFactoryImplementor factory) throws MappingException
AssociationType
Get the entity name of the associated entity
getAssociatedEntityName
in interface AssociationType
MappingException
public Object replaceElements(Object original, Object target, Object owner, Map copyCache, SharedSessionContractImplementor session)
Replace the elements of a collection with the elements of another collection.
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 mergedcopyCache
- The map of elements already replaced.session
- The session from which the merge event originated.protected Object instantiateResult(Object original)
Instantiate a new "underlying" collection exhibiting the same capacity charactersitcs and the passed "original".
original
- The original collection.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).
anticipatedSize
- The anticipated size of the instaniated collection
after we are done populating it.public Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map copyCache) throws HibernateException
Type
During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging. For immutable objects, or null values, it is safe to simply return the first parameter. For mutable objects, it is safe to return a copy of the first parameter. For objects with component values, it might make sense to recursively replace component values.
replace
in interface Type
original
- the value from the detached entity being mergedtarget
- the value in the managed entitysession
- The originating sessionowner
- The owner of the valuecopyCache
- The cache of already copied/replaced valuesHibernateException
- An error from Hibernatepublic final Type getElementType(SessionFactoryImplementor factory) throws MappingException
Get the Hibernate type of the collection elements
factory
- The session factory.MappingException
- Indicates the underlying persister could not be located.public String getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters) throws MappingException
AssociationType
Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition
getOnCondition
in interface AssociationType
MappingException
public String getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters, Set<String> treatAsDeclarations)
AssociationType
Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition
getOnCondition
in interface AssociationType
public Object getCollection(Serializable key, SharedSessionContractImplementor session, Object owner, Boolean overridingEager)
instantiate a collection wrapper (called when loading an object)
key
- The collection owner keysession
- The session from which the request is originating.owner
- The collection ownerpublic boolean hasHolder()
protected boolean initializeImmediately()
public String getLHSPropertyName()
AssociationType
Get the name of a property in the owning entity that provides the join key (null if the identifier)
getLHSPropertyName
in interface AssociationType
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
isAlwaysDirtyChecked
in interface AssociationType
public boolean[] toColumnNullness(Object value, Mapping mapping)
Type
Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
toColumnNullness
in interface Type
value
- an instance of the typemapping
- The mapping abstractionCopyright © 2001-2018 Red Hat, Inc. All Rights Reserved.