Package org.hibernate.type

Interface Type

    • Method Detail

      • isAssociationType

        boolean isAssociationType()
        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)
        Returns:
        True if this type is also an AssociationType implementor; false otherwise.

      • isCollectionType

        boolean isCollectionType()
        Return true if the implementation is castable to CollectionType. Essentially a polymorphic version of (type instanceof CollectionType.class)

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

        Returns:
        True if this type is also a CollectionType implementor; false otherwise.

      • isEntityType

        boolean isEntityType()
        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, isAssociationType() should also return true.

        Returns:
        True if this type is also an EntityType implementor; false otherwise.

      • isAnyType

        boolean isAnyType()
        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, isAssociationType() should also return true.

        Returns:
        True if this type is also an AnyType implementor; false otherwise.

      • isComponentType

        boolean isComponentType()
        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.
        Returns:
        True if this type is also a CompositeType implementor; false otherwise.

      • getColumnSpan

        int getColumnSpan​(Mapping mapping)
           throws MappingException
        How many columns are used to persist this type. Always the same as sqlTypes(mapping).length
        Parameters:
        mapping - The mapping object :/
        Returns:
        The number of columns
        Throws:
        MappingException - Generally indicates an issue accessing the passed mapping object.

      • sqlTypes

        int[] sqlTypes​(Mapping mapping)
        throws MappingException
        Return the JDBC types codes (per Types) for the columns mapped by this type.

        NOTE: The number of elements in this array matches the return from getColumnSpan(org.hibernate.engine.spi.Mapping).

        Parameters:
        mapping - The mapping object :/
        Returns:
        The JDBC type codes.
        Throws:
        MappingException - Generally indicates an issue accessing the passed mapping object.

      • dictatedSizes

        Size[] dictatedSizes​(Mapping mapping)
              throws MappingException
        Return the column sizes dictated by this type. For example, the mapping for a char/Character would have a dictated length limit of 1; for a string-based UUID would have a size limit of 36; etc.

        NOTE: The number of elements in this array matches the return from getColumnSpan(org.hibernate.engine.spi.Mapping).

        Parameters:
        mapping - The mapping object :/
        Returns:
        The dictated sizes.
        Throws:
        MappingException - Generally indicates an issue accessing the passed mapping object.

      • isSame

        boolean isSame​(java.lang.Object x,
               java.lang.Object y)
        throws HibernateException
        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 isEqual(java.lang.Object, java.lang.Object)

        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

        boolean isEqual​(java.lang.Object x,
                java.lang.Object y)
         throws HibernateException
        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).

        Parameters:
        x - The first value
        y - The second value
        Returns:
        True if there are considered equal (see discussion above).
        Throws:
        HibernateException - A problem occurred performing the comparison

      • isEqual

        boolean isEqual​(java.lang.Object x,
                java.lang.Object y,
                SessionFactoryImplementor factory)
         throws HibernateException
        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).

        Parameters:
        x - The first value
        y - The second value
        factory - The session factory
        Returns:
        True if there are considered equal (see discussion above).
        Throws:
        HibernateException - A problem occurred performing the comparison

      • getHashCode

        int getHashCode​(java.lang.Object x)
         throws HibernateException
        Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's hashCode.
        Parameters:
        x - The value for which to retrieve a hash code
        Returns:
        The hash code
        Throws:
        HibernateException - A problem occurred calculating the hash code

      • getHashCode

        int getHashCode​(java.lang.Object x,
                SessionFactoryImplementor factory)
         throws HibernateException
        Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's hashCode.
        Parameters:
        x - The value for which to retrieve a hash code
        factory - The session factory
        Returns:
        The hash code
        Throws:
        HibernateException - A problem occurred calculating the hash code

      • compare

        int compare​(java.lang.Object x,
            java.lang.Object y)
        Perform a Comparator style comparison between values
        Parameters:
        x - The first value
        y - The second value
        Returns:
        The comparison result. See Comparator.compare(T, T) for a discussion.

      • isDirty

        boolean isDirty​(java.lang.Object old,
                java.lang.Object current,
                SharedSessionContractImplementor session)
         throws HibernateException
        Should the parent be considered dirty, given both the old and current value?
        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

      • isDirty

        boolean isDirty​(java.lang.Object oldState,
                java.lang.Object currentState,
                boolean[] checkable,
                SharedSessionContractImplementor session)
         throws HibernateException
        Should the parent be considered dirty, given both the old and current value?
        Parameters:
        oldState - the old value
        currentState - the current value
        checkable - An array of booleans indicating which columns making up the value are actually checkable
        session - The session from which the request originated.
        Returns:
        true if the field is dirty
        Throws:
        HibernateException - A problem occurred performing the checking

      • nullSafeGet

        java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                             java.lang.String[] names,
                             SharedSessionContractImplementor session,
                             java.lang.Object owner)
                      throws HibernateException,
                             java.sql.SQLException
        Extract a value of the mapped class from the JDBC result set. Implementors should handle possibility of null values.
        Parameters:
        rs - The result set from which to extract value.
        names - the column names making up this type value (use to read from result set)
        session - The originating session
        owner - the parent entity
        Returns:
        The extracted value
        Throws:
        HibernateException - An error from Hibernate
        java.sql.SQLException - An error from the JDBC driver
        See Also:
        alternative, 2-phase property initialization

      • nullSafeGet

        java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                             java.lang.String name,
                             SharedSessionContractImplementor session,
                             java.lang.Object owner)
                      throws HibernateException,
                             java.sql.SQLException
        Extract a value of the mapped class from the JDBC result set. Implementors should handle possibility of null values. This form might be called if the type is known to be a single-column type.
        Parameters:
        rs - The result set from which to extract value.
        name - the column name making up this type value (use to read from result set)
        session - The originating session
        owner - the parent entity
        Returns:
        The extracted value
        Throws:
        HibernateException - An error from Hibernate
        java.sql.SQLException - An error from the JDBC driver

      • nullSafeSet

        void nullSafeSet​(java.sql.PreparedStatement st,
                 java.lang.Object value,
                 int index,
                 boolean[] settable,
                 SharedSessionContractImplementor session)
          throws HibernateException,
                 java.sql.SQLException
        Bind a value represented by an instance of the mapped class to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the possibility of null values. A multi-column type should bind parameters starting from index.
        Parameters:
        st - The JDBC prepared statement to which to bind
        value - the object to write
        index - starting parameter bind index
        settable - an array indicating which columns to bind/ignore
        session - The originating session
        Throws:
        HibernateException - An error from Hibernate
        java.sql.SQLException - An error from the JDBC driver

      • nullSafeSet

        void nullSafeSet​(java.sql.PreparedStatement st,
                 java.lang.Object value,
                 int index,
                 SharedSessionContractImplementor session)
          throws HibernateException,
                 java.sql.SQLException
        Bind a value represented by an instance of the mapped class to the JDBC prepared statement. Implementors should handle possibility of null values. A multi-column type should bind parameters starting from index.
        Parameters:
        st - The JDBC prepared statement to which to bind
        value - the object to write
        index - starting parameter bind index
        session - The originating session
        Throws:
        HibernateException - An error from Hibernate
        java.sql.SQLException - An error from the JDBC driver

      • toLoggableString

        java.lang.String toLoggableString​(java.lang.Object value,
                                  SessionFactoryImplementor factory)
                           throws HibernateException
        Generate a representation of the value for logging purposes.
        Parameters:
        value - The value to be logged
        factory - The session factory
        Returns:
        The loggable representation
        Throws:
        HibernateException - An error from Hibernate

      • getName

        java.lang.String getName()
        Returns the abbreviated name of the type.
        Returns:
        String the Hibernate type name

      • deepCopy

        java.lang.Object deepCopy​(java.lang.Object value,
                          SessionFactoryImplementor factory)
                   throws HibernateException
        Return a deep copy of the persistent state, stopping at entities and at collections.
        Parameters:
        value - The value to be copied
        factory - The session factory
        Returns:
        The deep copy
        Throws:
        HibernateException - An error from Hibernate

      • isMutable

        boolean isMutable()
        Are objects of this type mutable. (With respect to the referencing object ... entities and collections are considered immutable because they manage their own internal state.)
        Returns:
        boolean

      • disassemble

        java.io.Serializable disassemble​(java.lang.Object value,
                                 SharedSessionContractImplementor session,
                                 java.lang.Object owner)
                          throws HibernateException
        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.
        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

      • beforeAssemble

        void beforeAssemble​(java.io.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.
        Parameters:
        cached - The key
        session - The originating session

      • semiResolve

        java.lang.Object semiResolve​(java.lang.Object value,
                             SharedSessionContractImplementor session,
                             java.lang.Object owner)
                      throws HibernateException
        Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
        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

      • getSemiResolvedType

        Type getSemiResolvedType​(SessionFactoryImplementor factory)
        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
        Parameters:
        factory - The session factory
        Returns:
        The semi-resolved type

      • replace

        java.lang.Object replace​(java.lang.Object original,
                         java.lang.Object target,
                         SharedSessionContractImplementor session,
                         java.lang.Object owner,
                         java.util.Map copyCache)
                  throws HibernateException
        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.
        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
        Returns:
        the value to be merged
        Throws:
        HibernateException - An error from Hibernate

      • replace

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

      • toColumnNullness

        boolean[] toColumnNullness​(java.lang.Object value,
                           Mapping mapping)
        Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
        Parameters:
        value - an instance of the type
        mapping - The mapping abstraction
        Returns:
        array indicating column nullness for a value instance