Package org.hibernate.type

Class AbstractStandardBasicType<T>

    • Constructor Detail

      • AbstractStandardBasicType

        public AbstractStandardBasicType​(JdbcType jdbcType,
                                 JavaType<T> javaType)

    • Method Detail

      • toColumnNullness

        public boolean[] toColumnNullness​(Object value,
                                  Mapping mapping)
        Description copied from interface: Type
        Given an instance of the type, return an array of boolean values indicating which mapped columns would be null.
        Specified by:
        toColumnNullness in interface Type
        Parameters:
        value - an instance of the type
        mapping - The mapping abstraction
        Returns:
        array indicating column nullness for a value instance

      • getRegistrationKeys

        public String[] getRegistrationKeys()
        Description copied from interface: BasicType
        Get the names under which this type should be registered in the type registry.
        Specified by:
        getRegistrationKeys in interface BasicType<T>
        Returns:
        The keys under which to register this type.

      • registerUnderJavaType

        protected boolean registerUnderJavaType()

      • getReturnedClass

        public final Class getReturnedClass()
        Description copied from interface: Type
        The class handled by this type.
        Specified by:
        getReturnedClass in interface Type
        Returns:
        The java type class handled by this type.

      • isAssociationType

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

      • isAnyType

        public final 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 final boolean isSame​(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, 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).

      • isEqual

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

      • isEqual

        public boolean isEqual​(Object one,
                       Object another)
        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:
        one - The first value
        another - 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

      • getHashCode

        public final 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

      • isDirty

        public final boolean isDirty​(Object old,
                             Object current,
                             SharedSessionContractImplementor session)
        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

      • isDirty

        public final boolean isDirty​(Object old,
                             Object current,
                             boolean[] checkable,
                             SharedSessionContractImplementor session)
        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
        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

      • isDirty

        protected final boolean isDirty​(Object old,
                                Object current)

      • nullSafeSet

        public final void nullSafeSet​(PreparedStatement st,
                              Object value,
                              int index,
                              SharedSessionContractImplementor session)
                       throws SQLException
        Description copied from interface: Type
        Bind a value represented by an instance of the mapped class to the given JDBC PreparedStatement, 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.
        Specified by:
        nullSafeSet in interface Type
        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:
        SQLException - An error from the JDBC driver

      • toLoggableString

        public final String toLoggableString​(Object value,
                                     SessionFactoryImplementor factory)
        Description copied from interface: Type
        Generate a representation of the given value for logging purposes.
        Specified by:
        toLoggableString in interface Type
        Parameters:
        value - The value to be logged
        factory - The session factory
        Returns:
        The loggable representation

      • isMutable

        public final boolean isMutable()
        Description copied from interface: Type
        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.
        Specified by:
        isMutable in interface Type
        Returns:
        boolean

      • deepCopy

        public final Object deepCopy​(Object value,
                             SessionFactoryImplementor factory)
        Description copied from interface: Type
        Return a deep copy of the persistent state, stopping at entities and at collections.
        Specified by:
        deepCopy in interface Type
        Parameters:
        value - The value to be copied
        factory - The session factory
        Returns:
        The deep copy

      • deepCopy

        protected final T deepCopy​(T value)

      • disassemble

        public final 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

      • beforeAssemble

        public final 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

      • replace

        public final Object replace​(Object original,
                            Object target,
                            SharedSessionContractImplementor session,
                            Object owner,
                            Map<Object,​Object> copyCache)
        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
        Returns:
        the value to be merged

      • replace

        public Object replace​(Object original,
                      Object target,
                      SharedSessionContractImplementor session,
                      Object owner,
                      Map<Object,​Object> copyCache,
                      ForeignKeyDirection foreignKeyDirection)
        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

      • extract

        public T extract​(CallableStatement statement,
                 int startIndex,
                 SharedSessionContractImplementor session)
          throws SQLException
        Description copied from interface: OutputableType
        Perform the extraction
        Specified by:
        extract in interface OutputableType<T>
        Parameters:
        statement - The CallableStatement from which to extract the parameter value(s).
        startIndex - The parameter index from which to extract
        session - The originating session
        Returns:
        The extracted value.
        Throws:
        SQLException - Indicates an issue calling into the CallableStatement

      • nullSafeSet

        public void nullSafeSet​(PreparedStatement st,
                        Object value,
                        int index,
                        boolean[] settable,
                        SharedSessionContractImplementor session)
                 throws SQLException
        Description copied from interface: Type
        Bind a value represented by an instance of the mapped class to the given JDBC PreparedStatement, 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.
        Specified by:
        nullSafeSet in interface Type
        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:
        SQLException - An error from the JDBC driver