Package org.hibernate.type

Class AbstractStandardBasicType<T>

    • Method Detail

      • fromString

        public T fromString​(java.lang.String string)

      • toString

        public java.lang.String toString​(T value)
        Description copied from interface: StringRepresentableType
        Render the value to the string representation.
        Specified by:
        toString in interface StringRepresentableType<T>
        Parameters:
        value - The value to render to string.
        Returns:
        The string representation

      • toColumnNullness

        public boolean[] toColumnNullness​(java.lang.Object value,
                                  Mapping mapping)
        Description copied from interface: Type
        Given an instance of the type, return an array of boolean, 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 java.lang.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
        Returns:
        The keys under which to register this type.

      • registerUnderJavaType

        protected boolean registerUnderJavaType()

      • getDefaultSize

        protected static Size getDefaultSize()

      • getDictatedSize

        protected Size getDictatedSize()

      • setJavaTypeDescriptor

        public final void setJavaTypeDescriptor​(JavaTypeDescriptor<T> javaTypeDescriptor)

      • setSqlTypeDescriptor

        public final void setSqlTypeDescriptor​(SqlTypeDescriptor sqlTypeDescriptor)

      • getColumnSpan

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

      • dictatedSizes

        public Size[] dictatedSizes​(Mapping mapping)
                     throws MappingException
        Description copied from interface: Type
        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 Type.getColumnSpan(org.hibernate.engine.spi.Mapping).

        Specified by:
        dictatedSizes in interface Type
        Parameters:
        mapping - The mapping object :/
        Returns:
        The dictated sizes.
        Throws:
        MappingException - Generally indicates an issue accessing the passed mapping object.

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

      • isAnyType

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

      • isXMLElement

        public final boolean isXMLElement()

      • isSame

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

      • isEqual

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

      • isEqual

        public final boolean isEqual​(java.lang.Object one,
                             java.lang.Object another)
        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:
        one - The first value
        another - The second value
        Returns:
        True if there are considered equal (see discussion above).

      • getHashCode

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

      • getHashCode

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

      • compare

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

      • isDirty

        public final boolean isDirty​(java.lang.Object old,
                             java.lang.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​(java.lang.Object old,
                             java.lang.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​(java.lang.Object old,
                                java.lang.Object current)

      • nullSafeGet

        public final java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                                          java.lang.String[] names,
                                          SharedSessionContractImplementor session,
                                          java.lang.Object owner)
                                   throws java.sql.SQLException
        Description copied from interface: Type
        Extract a value of the mapped class from the JDBC result set. Implementors should handle possibility of null values.
        Specified by:
        nullSafeGet in interface Type
        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:
        java.sql.SQLException - An error from the JDBC driver
        See Also:
        alternative, 2-phase property initialization

      • nullSafeGet

        public final java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                                          java.lang.String name,
                                          SharedSessionContractImplementor session,
                                          java.lang.Object owner)
                                   throws java.sql.SQLException
        Description copied from interface: Type
        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.
        Specified by:
        nullSafeGet in interface 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:
        java.sql.SQLException - An error from the JDBC driver

      • nullSafeGet

        public final T nullSafeGet​(java.sql.ResultSet rs,
                           java.lang.String name,
                           SharedSessionContractImplementor session)
                    throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • nullSafeGet

        protected final T nullSafeGet​(java.sql.ResultSet rs,
                              java.lang.String name,
                              WrapperOptions options)
                       throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • nullSafeSet

        public final void nullSafeSet​(java.sql.PreparedStatement st,
                              java.lang.Object value,
                              int index,
                              SharedSessionContractImplementor session)
                       throws java.sql.SQLException
        Description copied from interface: Type
        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.
        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:
        java.sql.SQLException - An error from the JDBC driver

      • nullSafeSet

        protected final void nullSafeSet​(java.sql.PreparedStatement st,
                                 java.lang.Object value,
                                 int index,
                                 WrapperOptions options)
                          throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • toLoggableString

        public final java.lang.String toLoggableString​(java.lang.Object value,
                                               SessionFactoryImplementor factory)
        Description copied from interface: Type
        Generate a representation of the 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 java.lang.Object deepCopy​(java.lang.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 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

      • beforeAssemble

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

      • semiResolve

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

      • getSemiResolvedType

        public final 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 final java.lang.Object replace​(java.lang.Object original,
                                      java.lang.Object target,
                                      SharedSessionContractImplementor session,
                                      java.lang.Object owner,
                                      java.util.Map 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 java.lang.Object replace​(java.lang.Object original,
                                java.lang.Object target,
                                SharedSessionContractImplementor session,
                                java.lang.Object owner,
                                java.util.Map 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​(java.sql.CallableStatement statement,
                 int startIndex,
                 SharedSessionContractImplementor session)
          throws java.sql.SQLException
        Description copied from interface: ProcedureParameterExtractionAware
        Perform the extraction
        Specified by:
        extract in interface ProcedureParameterExtractionAware<T>
        Parameters:
        statement - The CallableStatement from which to extract the parameter value(s).
        startIndex - The parameter index from which to start extracting; assumes the values (if multiple) are contiguous
        session - The originating session
        Returns:
        The extracted value.
        Throws:
        java.sql.SQLException - Indicates an issue calling into the CallableStatement

      • extract

        public T extract​(java.sql.CallableStatement statement,
                 java.lang.String[] paramNames,
                 SharedSessionContractImplementor session)
          throws java.sql.SQLException
        Description copied from interface: ProcedureParameterExtractionAware
        Perform the extraction
        Specified by:
        extract in interface ProcedureParameterExtractionAware<T>
        Parameters:
        statement - The CallableStatement from which to extract the parameter value(s).
        paramNames - The parameter names.
        session - The originating session
        Returns:
        The extracted value.
        Throws:
        java.sql.SQLException - Indicates an issue calling into the CallableStatement

      • nullSafeSet

        public void nullSafeSet​(java.sql.CallableStatement st,
                        java.lang.Object value,
                        java.lang.String name,
                        SharedSessionContractImplementor session)
                 throws java.sql.SQLException
        Description copied from interface: ProcedureParameterNamedBinder
        Bind a value to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the possibility of null values. Does not support multi-column type
        Specified by:
        nullSafeSet in interface ProcedureParameterNamedBinder
        Parameters:
        st - The CallableStatement to which to bind
        value - the object to write
        name - parameter bind name
        session - The originating session
        Throws:
        java.sql.SQLException - An error from the JDBC driver

      • nullSafeSet

        protected final void nullSafeSet​(java.sql.CallableStatement st,
                                 java.lang.Object value,
                                 java.lang.String name,
                                 WrapperOptions options)
                          throws java.sql.SQLException
        Throws:
        java.sql.SQLException