Package org.hibernate.type

Class AbstractType

    • 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.

    • Constructor Detail

      • AbstractType

        public AbstractType()

    • Method Detail

      • 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.

      • 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.

      • 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

      • 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.

      • 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