Class AbstractType
- java.lang.Object
- org.hibernate.type.AbstractType
- All Implemented Interfaces:
Serializable,Type
- Direct Known Subclasses:
AnyType,CollectionType,ComponentType,CustomType,DiscriminatorType,EntityType,MetaType
public abstract classAbstractTypeextendsObjectimplementsType
Abstract superclass of the built-inTypehierarchy.- See Also:
- Serialized Form
Field Summary
Fields Modifier and Type Field Description protected staticSizeLEGACY_DEFAULT_SIZEDeprecated, for removal: This API element is subject to removal in a future version.protected staticSizeLEGACY_DICTATED_SIZEDeprecated, for removal: This API element is subject to removal in a future version.
Constructor Summary
Constructors Constructor Description AbstractType()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectassemble(Serializable cached,SharedSessionContractImplementor session,Object owner)Reconstruct the object from its disassembled state.voidbeforeAssemble(Serializable cached,SharedSessionContractImplementor session)Called before assembling a query result set from the query cache, to allow batch fetching of entities missing from the second-level cache.intcompare(Object x,Object y)Perform aComparator-style comparison of the given values.Serializabledisassemble(Object value,SessionFactoryImplementor sessionFactory)Return a disassembled representation of the object.Serializabledisassemble(Object value,SharedSessionContractImplementor session,Object owner)Return a disassembled representation of the object.intgetHashCode(Object x)Get a hash code, consistent with persistence "equality".intgetHashCode(Object x,SessionFactoryImplementor factory)Get a hash code, consistent with persistence "equality".booleanisAnyType()Return true if the implementation is castable toAnyType.booleanisAssociationType()Return true if the implementation is castable toAssociationType.booleanisCollectionType()Return true if the implementation is castable toCollectionType.booleanisComponentType()Return true if the implementation is castable toCompositeType.booleanisDirty(Object old,Object current,SharedSessionContractImplementor session)Should the parent be considered dirty, given both the old and current value?booleanisEntityType()Return true if the implementation is castable toEntityType.booleanisEqual(Object x,Object y)Compare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state.booleanisEqual(Object x,Object y,SessionFactoryImplementor factory)Compare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state.booleanisModified(Object old,Object current, boolean[] checkable,SharedSessionContractImplementor session)Has the value been modified compared to the current database state? The difference between this and theType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)methods is that here we need to account for "partially" built values.booleanisSame(Object x,Object y)Compare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state, taking a shortcut for entity references.Objectreplace(Object original,Object target,SharedSessionContractImplementor session,Object owner,Map<Object,Object> copyCache,ForeignKeyDirection foreignKeyDirection)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.Methods inherited from class java.lang.Object
clone,equals,finalize,getClass,hashCode,notify,notifyAll,toString,wait,wait,wait
Methods inherited from interface org.hibernate.type.Type
compare,deepCopy,getColumnSpan,getName,getReturnedClass,getReturnedClassName,getSqlTypeCodes,getTypeForEqualsHashCode,isDirty,isMutable,nullSafeSet,nullSafeSet,replace,toColumnNullness,toLoggableString
Field Detail
LEGACY_DICTATED_SIZE
@Deprecated(forRemoval=true)protected static final Size LEGACY_DICTATED_SIZE
Deprecated, for removal: This API element is subject to removal in a future version.
LEGACY_DEFAULT_SIZE
@Deprecated(forRemoval=true)protected static final Size LEGACY_DEFAULT_SIZE
Deprecated, for removal: This API element is subject to removal in a future version.
Method Detail
isAssociationType
public boolean isAssociationType()
Description copied from interface:TypeReturn true if the implementation is castable toAssociationType. This does not necessarily imply that the type actually represents an association. Shortcut fortype instanceof AssociationType.- Specified by:
isAssociationTypein interfaceType- Returns:
- True if this type is also an
AssociationTypeimplementor; false otherwise.
isCollectionType
public boolean isCollectionType()
Description copied from interface:TypeReturn true if the implementation is castable toCollectionType. Shortcut fortype instanceof CollectionTypeA
CollectionTypeis additionally anAssociationType; so if this method returns true,Type.isAssociationType()should also return true.- Specified by:
isCollectionTypein interfaceType- Returns:
- True if this type is also a
CollectionTypeimplementor; false otherwise.
isComponentType
public boolean isComponentType()
Description copied from interface:TypeReturn true if the implementation is castable toCompositeType. Shortcut fortype instanceof CompositeType.A component type may own collections or associations and hence must provide certain extra functionality.
- Specified by:
isComponentTypein interfaceType- Returns:
- True if this type is also a
CompositeTypeimplementor; false otherwise.
isEntityType
public boolean isEntityType()
Description copied from interface:TypeReturn true if the implementation is castable toEntityType. Shortcut fortype instanceof EntityType.An
EntityTypeis additionally anAssociationType; so if this method returns true,Type.isAssociationType()should also return true.- Specified by:
isEntityTypein interfaceType- Returns:
- True if this type is also an
EntityTypeimplementor; false otherwise.
compare
public int compare(Object x,Object y)
Description copied from interface:TypePerform aComparator-style comparison of the given values.- Specified by:
comparein interfaceType- Parameters:
x- The first valuey- The second value- Returns:
- The comparison result.
- See Also:
Comparator.compare(Object, Object)
disassemble
public Serializable disassemble(Object value,SharedSessionContractImplementor session,Object owner) throwsHibernateException
Description copied from interface:TypeReturn a disassembled representation of the object. This is the representation that is stored in the second-level cache.A reference to an associated entity should be disassembled to its primary key value.
- Specified by:
disassemblein interfaceType- Parameters:
value- the value to cachesession- the originating sessionowner- optional parent entity object (needed for collections)- Returns:
- the disassembled, deep cloned state
- Throws:
HibernateException- An error from Hibernate
disassemble
public Serializable disassemble(Object value,SessionFactoryImplementor sessionFactory) throwsHibernateException
Description copied from interface:TypeReturn a disassembled representation of the object. This is the representation that is stored in the second-level cache.A reference to an associated entity should be disassembled to its primary key value.
A high-quality implementation of this method should ensure that:
Objects.equals(disassemble(x,s), disassemble(y,s))== isEqual(x,y,sf)and that:
Objects.equals(x, assemble(disassemble(x,s),s,o))That is, the implementation must be consistent with
Type.isEqual(Object, Object, SessionFactoryImplementor)and withType.assemble(Serializable, SharedSessionContractImplementor, Object).- Specified by:
disassemblein interfaceType- Parameters:
value- the value to cachesessionFactory- the session factory- Returns:
- the disassembled, deep cloned state
- Throws:
HibernateException- An error from Hibernate
assemble
public Object assemble(Serializable cached,SharedSessionContractImplementor session,Object owner) throwsHibernateException
Description copied from interface:TypeReconstruct the object from its disassembled state. This function is the inverse ofType.disassemble(Object, SharedSessionContractImplementor, Object).- Specified by:
assemblein interfaceType- Parameters:
cached- the disassembled state from the cachesession- the originating sessionowner- the parent entity object- Returns:
- the (re)assembled object
- Throws:
HibernateException- An error from Hibernate
isDirty
public boolean isDirty(Object old,Object current,SharedSessionContractImplementor session) throwsHibernateException
Description copied from interface:TypeShould the parent be considered dirty, given both the old and current value?- Specified by:
isDirtyin interfaceType- Parameters:
old- the old valuecurrent- the current valuesession- The session from which the request originated.- Returns:
- true if the field is dirty
- Throws:
HibernateException- A problem occurred performing the checking
isAnyType
public boolean isAnyType()
Description copied from interface:TypeReturn true if the implementation is castable toAnyType. Shortcut fortype instanceof AnyType.An
AnyTypeis additionally anAssociationType; so if this method returns true, thenType.isAssociationType()should also return true.
isModified
public boolean isModified(Object old,Object current, boolean[] checkable,SharedSessionContractImplementor session) throwsHibernateException
Description copied from interface:TypeHas the value been modified compared to the current database state? The difference between this and theType.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 toType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor).- Specified by:
isModifiedin interfaceType- Parameters:
old- the database state, in a "hydrated" form, with identifiers unresolvedcurrent- the current state of the objectcheckable- which columns are actually checkablesession- The session from which the request originated.- Returns:
- true if the field has been modified
- Throws:
HibernateException- A problem occurred performing the checking
isSame
public boolean isSame(Object x,Object y) throwsHibernateException
Description copied from interface:TypeCompare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state, taking a shortcut for entity references.For most types this should boil down to anequality comparison of the given values, and it's reasonable to simply delegate to
Type.isEqual(Object, Object). But for associations the semantics are a bit different.- Specified by:
isSamein interfaceType- Parameters:
x- The first valuey- The second value- Returns:
- True if there are considered the same (see discussion above).
- Throws:
HibernateException- A problem occurred performing the comparison
isEqual
public boolean isEqual(Object x,Object y)
Description copied from interface:TypeCompare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state. For most types this could simply delegate toequals().This should always equate to some form of comparison of the value's internal state. As an example, for Java's
Dateclass, the comparison should be of its internal state, but based only on the specific part which is persistent (the timestamp, date, or time).
getHashCode
public int getHashCode(Object x)
Description copied from interface:TypeGet a hash code, consistent with persistence "equality". For most types this could simply delegate to the given value'shashCode.- Specified by:
getHashCodein interfaceType- Parameters:
x- The value for which to retrieve a hash code- Returns:
- The hash code
isEqual
public boolean isEqual(Object x,Object y,SessionFactoryImplementor factory)
Description copied from interface:TypeCompare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state. For most types this could simply delegate toType.isEqual(Object, Object).This should always equate to some form of comparison of the value's internal state. As an example, for Java's
Dateclass, the comparison should be of its internal state, but based only on the specific part which is persistent (the timestamp, date, or time).
getHashCode
public int getHashCode(Object x,SessionFactoryImplementor factory)
Description copied from interface:TypeGet a hash code, consistent with persistence "equality". For most types this could simply delegate toType.getHashCode(Object).- Specified by:
getHashCodein interfaceType- Parameters:
x- The value for which to retrieve a hash codefactory- The session factory- Returns:
- The hash code
replace
public Object replace(Object original,Object target,SharedSessionContractImplementor session,Object owner,Map<Object,Object> copyCache,ForeignKeyDirection foreignKeyDirection) throwsHibernateException
Description copied from interface:TypeDuring 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.- Specified by:
replacein interfaceType- Parameters:
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 valuesforeignKeyDirection- For associations, which direction does the foreign key point?- Returns:
- the value to be merged
- Throws:
HibernateException- An error from Hibernate
beforeAssemble
public void beforeAssemble(Serializable cached,SharedSessionContractImplementor session)
Description copied from interface:TypeCalled before assembling a query result set from the query cache, to allow batch fetching of entities missing from the second-level cache.- Specified by:
beforeAssemblein interfaceType- Parameters:
cached- The keysession- The originating session