Package org.hibernate.type

Class AbstractType

    • Field Detail

      • LEGACY_DICTATED_SIZE

        protected static final Size LEGACY_DICTATED_SIZE

      • LEGACY_DEFAULT_SIZE

        protected static final Size LEGACY_DEFAULT_SIZE

    • 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. Essentially a polymorphic version of (type instanceof AssociationType.class)
        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. Essentially a polymorphic version of (type instanceof CompositeType.class). 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. Essentially a polymorphic version of (type instanceof EntityType.class).

        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​(java.lang.Object x,
                   java.lang.Object y)
        Description copied from interface: Type
        Perform a Comparator style comparison between values
        Specified by:
        compare in interface Type
        Parameters:
        x - The first value
        y - The second value
        Returns:
        The comparison result. See Comparator.compare(T, T) for a discussion.

      • disassemble

        public java.io.Serializable disassemble​(java.lang.Object value,
                                        SharedSessionContractImplementor session,
                                        java.lang.Object owner)
                                 throws HibernateException
        Description copied from interface: 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.
        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​(java.lang.Object old,
                       java.lang.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

      • semiResolve

        public java.lang.Object semiResolve​(java.lang.Object value,
                                    SharedSessionContractImplementor session,
                                    java.lang.Object owner)
                             throws HibernateException
        Description copied from interface: Type
        Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
        Specified by:
        semiResolve in interface Type
        Parameters:
        value - The unresolved, hydrated value
        session - THe originating session
        owner - The value owner
        Returns:
        The semi-resolved value
        Throws:
        HibernateException - An error from Hibernate

      • isAnyType

        public boolean isAnyType()
        Description copied from interface: Type
        Return true if the implementation is castable to AnyType. Essentially a polymorphic version of (type instanceof AnyType.class).

        An AnyType is additionally an AssociationType; so if this method returns true, 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​(java.lang.Object x,
                      java.lang.Object y)
               throws HibernateException
        Description copied from interface: Type
        Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references.

        For most types this should equate to an equals check on the values. For associations the implication is a bit different. For most types it is conceivable to simply delegate to Type.isEqual(java.lang.Object, java.lang.Object)

        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​(java.lang.Object x,
                       java.lang.Object y)
        Description copied from interface: Type
        Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).

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

        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​(java.lang.Object x)
        Description copied from interface: Type
        Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the 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​(java.lang.Object x,
                       java.lang.Object y,
                       SessionFactoryImplementor factory)
        Description copied from interface: Type
        Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).

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

        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​(java.lang.Object x,
                       SessionFactoryImplementor factory)
        Description copied from interface: Type
        Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's hashCode.
        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

      • getSemiResolvedType

        public Type getSemiResolvedType​(SessionFactoryImplementor factory)
        Description copied from interface: Type
        As part of 2-phase loading, when we perform resolving what is the resolved type for this type? Generally speaking the type and its semi-resolved type will be the same. The main deviation from this is in the case of an entity where the type would be the entity type and semi-resolved type would be its identifier type
        Specified by:
        getSemiResolvedType in interface Type
        Parameters:
        factory - The session factory
        Returns:
        The semi-resolved type

      • replace

        public java.lang.Object replace​(java.lang.Object original,
                                java.lang.Object target,
                                SharedSessionContractImplementor session,
                                java.lang.Object owner,
                                java.util.Map 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​(java.io.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