Package org.hibernate.type

Class CustomType

    • Method Detail

      • getUserType

        public UserType getUserType()

      • 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
        Returns:
        The keys under which to register this type.

      • sqlTypes

        public int[] sqlTypes​(Mapping pi)
        Description copied from interface: Type
        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 Type.getColumnSpan(org.hibernate.engine.spi.Mapping).

        Specified by:
        sqlTypes in interface Type
        Parameters:
        pi - The mapping object :/
        Returns:
        The JDBC type codes.

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

      • getColumnSpan

        public int getColumnSpan​(Mapping session)
        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:
        session - The mapping object :/
        Returns:
        The number of columns

      • isEqual

        public boolean isEqual​(Object x,
                       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).

        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
        Overrides:
        isEqual in class AbstractType
        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

      • getHashCode

        public int getHashCode​(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
        Overrides:
        getHashCode in class AbstractType
        Parameters:
        x - The value for which to retrieve a hash code
        Returns:
        The hash code

      • nullSafeGet

        public Object nullSafeGet​(ResultSet rs,
                          String columnName,
                          SharedSessionContractImplementor session,
                          Object owner)
                   throws 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.
        columnName - 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:
        SQLException - An error from the JDBC driver

      • disassemble

        public Serializable disassemble​(Object value,
                                SharedSessionContractImplementor session,
                                Object owner)
        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
        Overrides:
        disassemble in class AbstractType
        Parameters:
        value - the value to cache
        session - the originating session
        owner - optional parent entity object (needed for collections)
        Returns:
        the disassembled, deep cloned state

      • replace

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

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

      • nullSafeSet

        public 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 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:
        SQLException - An error from the JDBC driver

      • getName

        public String getName()
        Description copied from interface: Type
        Returns the abbreviated name of the type.
        Specified by:
        getName in interface Type
        Returns:
        String the Hibernate type name

      • isMutable

        public 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

      • stringToObject

        public Object stringToObject​(String xml)
        Description copied from interface: IdentifierType
        Convert the value from the mapping file to a Java object.
        Specified by:
        stringToObject in interface IdentifierType
        Parameters:
        xml - the value of discriminator-value or unsaved-value attribute
        Returns:
        The converted value of the string representation.

      • objectToSQLString

        public String objectToSQLString​(Object value,
                                Dialect dialect)
                         throws Exception
        Description copied from interface: LiteralType
        Convert the value into a string representation, suitable for embedding in an SQL statement as a literal.
        Specified by:
        objectToSQLString in interface LiteralType
        Parameters:
        value - The value to convert
        dialect - The SQL dialect
        Returns:
        The value's string representation
        Throws:
        Exception - Indicates an issue converting the value to literal string.

      • getComparator

        public Comparator getComparator()
        Description copied from interface: VersionType
        Get a comparator for version values.
        Specified by:
        getComparator in interface VersionType
        Returns:
        The comparator to use to compare different version values.

      • toColumnNullness

        public boolean[] toColumnNullness​(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

      • isDirty

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object