Package org.hibernate.type

Class MetaType

    • Field Detail

      • REGISTRATION_KEYS

        public static final String[] REGISTRATION_KEYS

    • Constructor Detail

      • MetaType

        public MetaType​(Map<Object,​String> discriminatorValuesToEntityNameMap,
                Type baseType)

    • Method Detail

      • getBaseType

        public Type getBaseType()

      • getRegistrationKeys

        public String[] getRegistrationKeys()

      • getDiscriminatorValuesToEntityNameMap

        public Map<Object,​String> getDiscriminatorValuesToEntityNameMap()

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

        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 mapping)
                  throws MappingException
        Description copied from interface: Type
        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.

      • getReturnedClass

        public Class getReturnedClass()
        Description copied from interface: Type
        The class returned by #nullSafeGet methods. This is used to establish the class of an array of this type.
        Returns:
        The java type class handled by this type.

      • nullSafeSet

        public void nullSafeSet​(PreparedStatement st,
                        Object value,
                        int index,
                        SharedSessionContractImplementor session)
                 throws HibernateException,
                        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.
        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
        SQLException - An error from the JDBC driver

      • nullSafeSet

        public void nullSafeSet​(PreparedStatement st,
                        Object value,
                        int index,
                        boolean[] settable,
                        SharedSessionContractImplementor session)
                 throws HibernateException,
                        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.
        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
        SQLException - An error from the JDBC driver

      • toLoggableString

        public String toLoggableString​(Object value,
                               SessionFactoryImplementor factory)
                        throws HibernateException
        Description copied from interface: Type
        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

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

      • deepCopy

        public Object deepCopy​(Object value,
                       SessionFactoryImplementor factory)
                throws HibernateException
        Description copied from interface: Type
        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

      • replace

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

      • 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.)
        Returns:
        boolean

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