|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.hibernate.type.AbstractType org.hibernate.type.CollectionType
public abstract class CollectionType
A type that handles Hibernate PersistentCollections (including arrays).
Field Summary | |
---|---|
static Object |
UNFETCHED_COLLECTION
|
Constructor Summary | |
---|---|
CollectionType(TypeFactory.TypeScope typeScope,
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)
Perform a Comparator style comparison between values |
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(org.dom4j.Node xml,
Mapping factory)
Parse the XML representation of an instance. |
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,
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. |
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 |
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,
EntityMode entityMode)
Get a hash code, 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()
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 |
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(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()
Return true if the implementation is castable to CollectionType . |
boolean |
isDirty(Object old,
Object current,
boolean[] checkable,
SessionImplementor session)
Should the parent be considered dirty, given both the old and current value? |
boolean |
isDirty(Object old,
Object current,
SessionImplementor session)
Should the parent be considered dirty, given both the old and current 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 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.SessionImplementor) methods is that here we need to account for "partially" built values. |
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)
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,
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(org.dom4j.Node node,
Object value,
SessionFactoryImplementor factory)
A representation of the value to be embedded in an XML element. |
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)
A representation of the value to be embedded in a log file. |
String |
toString()
|
boolean |
useLHSPrimaryKey()
Is the primary key of the owning entity table to be used in the join? |
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 |
---|
beforeAssemble, getHashCode, getSemiResolvedType, isAnyType, isComponentType, isEntityType, isEqual, isSame, replace, replaceNode |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.hibernate.type.Type |
---|
beforeAssemble, getHashCode, getReturnedClass, getSemiResolvedType, isAnyType, isComponentType, isEntityType, isEqual, isSame, replace |
Field Detail |
---|
public static final Object UNFETCHED_COLLECTION
Constructor Detail |
---|
public CollectionType(TypeFactory.TypeScope typeScope, String role, String foreignKeyPropertyName, boolean isEmbeddedInXML)
Method Detail |
---|
public boolean isEmbeddedInXML()
isEmbeddedInXML
in interface AssociationType
public String getRole()
public Object indexOf(Object collection, Object element)
public boolean contains(Object collection, Object childObject, SessionImplementor session)
public boolean isCollectionType()
Type
CollectionType
. Essentially a polymorphic version of
(type instanceof CollectionType.class)
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, EntityMode entityMode)
Type
isEqual
in interface Type
isEqual
in class AbstractType
x
- The first valuey
- The second valueentityMode
- The entity mode of the values.
public int compare(Object x, Object y, EntityMode entityMode)
Type
Comparator
style comparison between values
compare
in interface Type
compare
in class AbstractType
x
- The first valuey
- The second valueentityMode
- The entity mode of the values.
Comparator.compare(T, T)
for a discussion.public int getHashCode(Object x, EntityMode entityMode)
Type
#hashCode
.
getHashCode
in interface Type
getHashCode
in class AbstractType
x
- The value for which to retrieve a hash codeentityMode
- The entity mode of the value.
public abstract PersistentCollection instantiate(SessionImplementor session, CollectionPersister persister, Serializable key)
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, SessionImplementor session, Object owner) throws SQLException
Type
nullSafeGet
in interface Type
name
- the column nameowner
- the parent entity
SQLException
public Object nullSafeGet(ResultSet rs, String[] name, SessionImplementor session, Object owner) throws HibernateException, SQLException
Type
nullSafeGet
in interface Type
name
- the column namesowner
- the parent entity
HibernateException
SQLException
alternative, 2-phase property initialization
public final void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session) throws HibernateException, SQLException
Type
nullSafeSet
in interface Type
value
- the object to writeindex
- statement parameter indexsettable
- an array indicating which columns to ignore
HibernateException
SQLException
public void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) throws HibernateException, SQLException
Type
nullSafeSet
in interface Type
value
- the object to writeindex
- statement parameter index
HibernateException
SQLException
public int[] sqlTypes(Mapping session) throws MappingException
Type
Types
) for the columns mapped by this type.
sqlTypes
in interface Type
session
- The mapping object :/
MappingException
- Generally indicates an issue accessing the passed mapping object.public int getColumnSpan(Mapping session) throws MappingException
Type
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
toLoggableString
in interface Type
HibernateException
protected String renderLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
HibernateException
public Object deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory) throws HibernateException
Type
deepCopy
in interface Type
value
- generally a collection element or entity field
HibernateException
public String getName()
Type
getName
in interface Type
public Iterator getElementsIterator(Object collection, SessionImplementor session)
collection
- The collection to be iteratedsession
- The session from which the request is originating.
protected Iterator getElementsIterator(Object collection)
collection
- The collection to be iterated
public boolean isMutable()
Type
isMutable
in interface Type
public Serializable disassemble(Object value, SessionImplementor session, Object owner) throws HibernateException
Type
disassemble
in interface Type
disassemble
in class AbstractType
value
- the value to cachesession
- the sessionowner
- optional parent entity object (needed for collections)
HibernateException
public Object assemble(Serializable cached, SessionImplementor session, Object owner) throws HibernateException
Type
assemble
in interface Type
assemble
in class AbstractType
cached
- the disassembled state from the cachesession
- the sessionowner
- the parent entity object
HibernateException
public boolean isDirty(Object old, Object current, SessionImplementor session) throws HibernateException
Type
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, SessionImplementor session) throws HibernateException
Type
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(SessionImplementor session, Object collection)
session
- The session from which the request is originating.collection
- The bare collection to be wrapped.
public boolean isAssociationType()
isAssociationType
in interface Type
isAssociationType
in class AbstractType
AssociationType
implementor; false otherwise.public ForeignKeyDirection getForeignKeyDirection()
AssociationType
getForeignKeyDirection
in interface AssociationType
public Serializable getKeyOfOwner(Object owner, SessionImplementor session)
owner
- The collection ownersession
- The session from which the request is originating.
public Serializable getIdOfOwnerOrNull(Serializable key, SessionImplementor session)
key
- The collection owner keysession
- The session from which the request is originating.
public Object hydrate(ResultSet rs, String[] name, SessionImplementor session, Object owner)
Type
hydrate
in interface Type
hydrate
in class AbstractType
name
- the column namessession
- the sessionowner
- the parent entity
Type.resolve(Object, SessionImplementor, Object)
public Object resolve(Object value, SessionImplementor session, Object owner) throws HibernateException
Type
resolve
in interface Type
resolve
in class AbstractType
value
- an identifier or value returned by hydrate()session
- the sessionowner
- the parent entity
HibernateException
Type.hydrate(ResultSet, String[], SessionImplementor, Object)
public Object semiResolve(Object value, SessionImplementor session, Object owner) throws HibernateException
Type
semiResolve
in interface Type
semiResolve
in class AbstractType
HibernateException
public boolean isArrayType()
public boolean useLHSPrimaryKey()
AssociationType
useLHSPrimaryKey
in interface AssociationType
public String getRHSUniqueKeyPropertyName()
AssociationType
getRHSUniqueKeyPropertyName
in interface AssociationType
public Joinable getAssociatedJoinable(SessionFactoryImplementor factory) throws MappingException
AssociationType
getAssociatedJoinable
in interface AssociationType
MappingException
public boolean isModified(Object old, Object current, boolean[] checkable, SessionImplementor session) throws HibernateException
Type
Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.SessionImplementor)
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.SessionImplementor)
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
getAssociatedEntityName
in interface AssociationType
MappingException
public Object replaceElements(Object original, Object target, Object owner, Map copyCache, SessionImplementor session)
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)
original
- The original collection.
public abstract Object instantiate(int anticipatedSize)
anticipatedSize
- The anticipated size of the instaniated collection
after we are done populating it.
public Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache) throws HibernateException
replace
in interface Type
original
- the value from the detached entity being mergedtarget
- the value in the managed entity
HibernateException
public final Type getElementType(SessionFactoryImplementor factory) throws MappingException
factory
- The session factory.
MappingException
- Indicates the underlying persister could not be located.public String toString()
toString
in class Object
public String getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters) throws MappingException
AssociationType
getOnCondition
in interface AssociationType
MappingException
public Object getCollection(Serializable key, SessionImplementor session, Object owner)
key
- The collection owner keysession
- The session from which the request is originating.owner
- The collection owner
public boolean hasHolder(EntityMode entityMode)
protected boolean initializeImmediately(EntityMode entityMode)
public String getLHSPropertyName()
AssociationType
getLHSPropertyName
in interface AssociationType
public boolean isXMLElement()
isXMLElement
in interface Type
isXMLElement
in class AbstractType
public Object fromXMLNode(org.dom4j.Node xml, Mapping factory) throws HibernateException
Type
fromXMLNode
in interface Type
HibernateException
public void setToXMLNode(org.dom4j.Node node, Object value, SessionFactoryImplementor factory) throws HibernateException
Type
setToXMLNode
in interface Type
HibernateException
public boolean isAlwaysDirtyChecked()
isAlwaysDirtyChecked
in interface AssociationType
public boolean[] toColumnNullness(Object value, Mapping mapping)
Type
toColumnNullness
in interface Type
value
- an instance of the type
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |