Package org.hibernate.type

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 class AbstractType extends Object implements Type
Abstract superclass of the built-in Type hierarchy.
See Also:

  • Constructor Details

    • AbstractType

      public AbstractType()

  • Method Details

    • isAssociationType

      public boolean isAssociationType()
      Description copied from interface: Type
      Return true if the implementation is castable to AssociationType. This does not necessarily imply that the type actually represents an association. Shortcut for type instanceof AssociationType.
      Specified by:
      isAssociationType in interface Type
      Returns:
      True if this type is also an AssociationType implementor; false otherwise.

    • isCollectionType

      public boolean isCollectionType()
      Description copied from interface: Type
      Return true if the implementation is castable to CollectionType. Shortcut for type instanceof CollectionType

      A CollectionType is additionally an AssociationType; so if this method returns true, Type.isAssociationType() should also return true.

      Specified by:
      isCollectionType in interface Type
      Returns:
      True if this type is also a CollectionType implementor; false otherwise.

    • isComponentType

      public boolean isComponentType()
      Description copied from interface: Type
      Return true if the implementation is castable to CompositeType. Shortcut for type instanceof CompositeType.

      A component type may own collections or associations and hence must provide certain extra functionality.

      Specified by:
      isComponentType in interface Type
      Returns:
      True if this type is also a CompositeType implementor; false otherwise.

    • isEntityType

      public boolean isEntityType()
      Description copied from interface: Type
      Return true if the implementation is castable to EntityType. Shortcut for type instanceof EntityType.

      An EntityType is additionally an AssociationType; so if this method returns true, Type.isAssociationType() should also return true.

      Specified by:
      isEntityType in interface Type
      Returns:
      True if this type is also an EntityType implementor; false otherwise.

    • compare

      public int compare(Object x, Object y)
      Description copied from interface: Type
      Perform a Comparator-style comparison of the given values.
      Specified by:
      compare in interface Type
      Parameters:
      x - The first value
      y - The second value
      Returns:
      The comparison result.
      See Also:

    • disassemble

      public Serializable disassemble(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
      Description copied from interface: Type
      Return 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:
      disassemble in interface Type
      Parameters:
      value - the value to cache
      session - the originating session
      owner - 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) throws HibernateException
      Description copied from interface: Type
      Return 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 with Type.assemble(Serializable, SharedSessionContractImplementor, Object).

      Specified by:
      disassemble in interface Type
      Parameters:
      value - the value to cache
      sessionFactory - 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) throws HibernateException
      Description copied from interface: Type
      Reconstruct the object from its disassembled state. This function is the inverse of Type.disassemble(Object, SharedSessionContractImplementor, Object).
      Specified by:
      assemble in interface Type
      Parameters:
      cached - the disassembled state from the cache
      session - the originating session
      owner - 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) throws HibernateException
      Description copied from interface: Type
      Should the parent be considered dirty, given both the old and current value?
      Specified by:
      isDirty in interface Type
      Parameters:
      old - the old value
      current - the current value
      session - 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: Type
      Return true if the implementation is castable to AnyType. Shortcut for type instanceof AnyType.

      An AnyType is additionally an AssociationType; so if this method returns true, then Type.isAssociationType() should also return true.

      Specified by:
      isAnyType in interface Type
      Returns:
      True if this type is also an AnyType implementor; false otherwise.

    • isModified

      public boolean isModified(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
      Description copied from interface: 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).
      Specified by:
      isModified in interface Type
      Parameters:
      old - the database state, in a "hydrated" form, with identifiers unresolved
      current - the current state of the object
      checkable - which columns are actually checkable
      session - 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) throws HibernateException
      Description copied from interface: Type
      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.

      For most types this should boil down to an equality 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:
      isSame in interface Type
      Parameters:
      x - The first value
      y - 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: Type
      Compare 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 to equals().

      This should always equate to some form of comparison of the value's internal state. As an example, for Java's Date class, the comparison should be of its internal state, but based only on the specific part which is persistent (the timestamp, date, or time).

      Specified by:
      isEqual in interface Type
      Parameters:
      x - The first value
      y - The second value
      Returns:
      True if there are considered equal (see discussion above).

    • getHashCode

      public int getHashCode(Object x)
      Description copied from interface: Type
      Get a hash code, consistent with persistence "equality". For most types this could simply delegate to the given value's hashCode.
      Specified by:
      getHashCode in interface Type
      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: Type
      Compare 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 to Type.isEqual(Object, Object).

      This should always equate to some form of comparison of the value's internal state. As an example, for Java's Date class, the comparison should be of its internal state, but based only on the specific part which is persistent (the timestamp, date, or time).

      Specified by:
      isEqual in interface Type
      Parameters:
      x - The first value
      y - The second value
      factory - The session factory
      Returns:
      True if there are considered equal (see discussion above).

    • getHashCode

      public int getHashCode(Object x, SessionFactoryImplementor factory)
      Description copied from interface: Type
      Get a hash code, consistent with persistence "equality". For most types this could simply delegate to Type.getHashCode(Object).
      Specified by:
      getHashCode in interface Type
      Parameters:
      x - The value for which to retrieve a hash code
      factory - 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) throws HibernateException
      Description copied from interface: 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.
      Specified by:
      replace in interface Type
      Parameters:
      original - the value from the detached entity being merged
      target - the value in the managed entity
      session - The originating session
      owner - The owner of the value
      copyCache - The cache of already copied/replaced values
      foreignKeyDirection - 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: Type
      Called before assembling a query result set from the query cache, to allow batch fetching of entities missing from the second-level cache.
      Specified by:
      beforeAssemble in interface Type
      Parameters:
      cached - The key
      session - The originating session