Package org.hibernate.type

Class AnyType

    • Constructor Detail

      • AnyType

        protected AnyType​(Type discriminatorType,
                  Type identifierType)
        Intended for use only from legacy ObjectType type definition

    • Method Detail

      • getIdentifierType

        public Type getIdentifierType()

      • getDiscriminatorType

        public Type getDiscriminatorType()

      • getName

        public java.lang.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

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

      • getPropertyValues

        public java.lang.Object[] getPropertyValues​(java.lang.Object component,
                                            EntityMode entityMode)
        Description copied from interface: CompositeType
        Extract the values of the component properties from the given component instance without access to the session.

        An optional operation

        Specified by:
        getPropertyValues in interface CompositeType
        Parameters:
        component - The component instance
        entityMode - The entity mode
        Returns:
        The property values

      • isAnyType

        public 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
        Overrides:
        isAnyType in class AbstractType
        Returns:
        True if this type is also an AnyType implementor; false otherwise.

      • isAssociationType

        public 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
        Overrides:
        isAssociationType in class AbstractType
        Returns:
        True if this type is also an AssociationType implementor; false otherwise.

      • isComponentType

        public 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
        Overrides:
        isComponentType in class AbstractType
        Returns:
        True if this type is also a CompositeType implementor; false otherwise.

      • isEmbedded

        public boolean isEmbedded()
        Description copied from interface: CompositeType
        Is this component embedded? "embedded" indicates that the component is "virtual", that its properties are "flattened" onto its owner
        Specified by:
        isEmbedded in interface CompositeType
        Returns:
        True if this component is embedded; false otherwise.

      • 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

      • deepCopy

        public 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

      • compare

        public 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
        Overrides:
        compare in class AbstractType
        Parameters:
        x - The first value
        y - The second value
        Returns:
        The comparison result. See Comparator.compare(T, T) for a discussion.

      • isSame

        public boolean isSame​(java.lang.Object x,
                      java.lang.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) 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
        Overrides:
        isSame in class AbstractType
        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

      • 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

      • isDirty

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

      • 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

      • nullSafeGet

        public java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                                    java.lang.String[] names,
                                    SharedSessionContractImplementor session,
                                    java.lang.Object owner)
                             throws HibernateException,
                                    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:
        HibernateException - An error from Hibernate
        java.sql.SQLException - An error from the JDBC driver
        See Also:
        alternative, 2-phase property initialization

      • nullSafeSet

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

      • nullSafeSet

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

      • toLoggableString

        public java.lang.String toLoggableString​(java.lang.Object value,
                                         SessionFactoryImplementor factory)
                                  throws HibernateException
        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
        Throws:
        HibernateException - An error from Hibernate

      • disassemble

        public 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
        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
        Throws:
        HibernateException - An error from Hibernate

      • replace

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

      • nullSafeGet

        public java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                                    java.lang.String name,
                                    SharedSessionContractImplementor session,
                                    java.lang.Object owner)
        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

      • semiResolve

        public java.lang.Object semiResolve​(java.lang.Object value,
                                    SharedSessionContractImplementor session,
                                    java.lang.Object owner)
        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
        Overrides:
        semiResolve in class AbstractType
        Parameters:
        value - The unresolved, hydrated value
        session - THe originating session
        owner - The value owner
        Returns:
        The semi-resolved value

      • isMethodOf

        public boolean isMethodOf​(java.lang.reflect.Method method)
        Description copied from interface: CompositeType
        Is the given method a member of this component's class?
        Specified by:
        isMethodOf in interface CompositeType
        Parameters:
        method - The method to check
        Returns:
        True if the method is a member; false otherwise.

      • getPropertyNames

        public java.lang.String[] getPropertyNames()
        Description copied from interface: CompositeType
        Get the names of the component properties
        Specified by:
        getPropertyNames in interface CompositeType
        Returns:
        The component property names

      • getPropertyIndex

        public int getPropertyIndex​(java.lang.String name)
        Description copied from interface: CompositeType
        Convenience method for locating the property index for a given property name.
        Specified by:
        getPropertyIndex in interface CompositeType
        Parameters:
        name - The (sub-)property name to find.
        Returns:
        The (sub-)property index, relative to all the array-valued method returns defined on this contract.

      • getPropertyValue

        public java.lang.Object getPropertyValue​(java.lang.Object component,
                                         int i,
                                         SharedSessionContractImplementor session)
                                  throws HibernateException
        Description copied from interface: CompositeType
        Extract a particular component property value indicated by index.
        Specified by:
        getPropertyValue in interface CompositeType
        Parameters:
        component - The component instance
        i - The index of the property whose value is to be extracted
        session - The session from which the request originates.
        Returns:
        The extracted component property value
        Throws:
        HibernateException - Indicates a problem access the property value.

      • getPropertyValues

        public java.lang.Object[] getPropertyValues​(java.lang.Object component,
                                            SharedSessionContractImplementor session)
                                     throws HibernateException
        Description copied from interface: CompositeType
        Extract the values of the component properties from the given component instance
        Specified by:
        getPropertyValues in interface CompositeType
        Parameters:
        component - The component instance
        session - The session from which the request originates
        Returns:
        The property values
        Throws:
        HibernateException - Indicates a problem access the property values.

      • setPropertyValues

        public void setPropertyValues​(java.lang.Object component,
                              java.lang.Object[] values,
                              EntityMode entityMode)
        Description copied from interface: CompositeType
        Inject property values onto the given component instance

        An optional operation

        Specified by:
        setPropertyValues in interface CompositeType
        Parameters:
        component - The component instance
        values - The values to inject
        entityMode - The entity mode

      • getPropertyNullability

        public boolean[] getPropertyNullability()
        Description copied from interface: CompositeType
        Retrieve the indicators regarding which component properties are nullable.

        An optional operation

        Specified by:
        getPropertyNullability in interface CompositeType
        Returns:
        nullability of component properties

      • getSubtypes

        public Type[] getSubtypes()
        Description copied from interface: CompositeType
        Get the types of the component properties
        Specified by:
        getSubtypes in interface CompositeType
        Returns:
        The component property types.

      • getCascadeStyle

        public CascadeStyle getCascadeStyle​(int i)
        Description copied from interface: CompositeType
        Retrieve the cascade style of the indicated component property.
        Specified by:
        getCascadeStyle in interface CompositeType
        Parameters:
        i - The property index,
        Returns:
        The cascade style.

      • getFetchMode

        public FetchMode getFetchMode​(int i)
        Description copied from interface: CompositeType
        Retrieve the fetch mode of the indicated component property.
        Specified by:
        getFetchMode in interface CompositeType
        Parameters:
        i - The property index,
        Returns:
        The fetch mode

      • useLHSPrimaryKey

        public boolean useLHSPrimaryKey()
        Description copied from interface: AssociationType
        Is the primary key of the owning entity table to be used in the join?
        Specified by:
        useLHSPrimaryKey in interface AssociationType

      • getLHSPropertyName

        public java.lang.String getLHSPropertyName()
        Description copied from interface: AssociationType
        Get the name of a property in the owning entity that provides the join key (null if the identifier)
        Specified by:
        getLHSPropertyName in interface AssociationType

      • isReferenceToPrimaryKey

        public boolean isReferenceToPrimaryKey()

      • getRHSUniqueKeyPropertyName

        public java.lang.String getRHSUniqueKeyPropertyName()
        Description copied from interface: AssociationType
        The name of a unique property of the associated entity that provides the join key (null if the identifier of an entity, or key of a collection)
        Specified by:
        getRHSUniqueKeyPropertyName in interface AssociationType

      • isAlwaysDirtyChecked

        public boolean isAlwaysDirtyChecked()
        Description copied from interface: AssociationType
        Do we dirty check this association, even when there are no columns to be updated?
        Specified by:
        isAlwaysDirtyChecked in interface AssociationType

      • getOnCondition

        public java.lang.String getOnCondition​(java.lang.String alias,
                                       SessionFactoryImplementor factory,
                                       java.util.Map enabledFilters)
        Description copied from interface: AssociationType
        Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition
        Specified by:
        getOnCondition in interface AssociationType

      • getOnCondition

        public java.lang.String getOnCondition​(java.lang.String alias,
                                       SessionFactoryImplementor factory,
                                       java.util.Map enabledFilters,
                                       java.util.Set<java.lang.String> treatAsDeclarations)
        Description copied from interface: AssociationType
        Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition
        Specified by:
        getOnCondition in interface AssociationType