Package org.hibernate.type

Class CollectionType

    • Field Detail

      • UNFETCHED_COLLECTION

        public static final java.lang.Object UNFETCHED_COLLECTION

    • Constructor Detail

      • CollectionType

        @Deprecated
public CollectionType​(TypeFactory.TypeScope typeScope,
                      java.lang.String role,
                      java.lang.String foreignKeyPropertyName)
        Deprecated.
        Use the other constructor

      • CollectionType

        public CollectionType​(java.lang.String role,
                      java.lang.String foreignKeyPropertyName)

    • Method Detail

      • getRole

        public java.lang.String getRole()

      • indexOf

        public java.lang.Object indexOf​(java.lang.Object collection,
                                java.lang.Object element)

      • isEqual

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

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

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

      • getHashCode

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

      • instantiate

        public abstract PersistentCollection instantiate​(SharedSessionContractImplementor session,
                                                 CollectionPersister persister,
                                                 java.io.Serializable key)
        Instantiate an uninitialized collection wrapper or holder. Callers MUST add the holder to the persistence context!
        Parameters:
        session - The session from which the request is originating.
        persister - The underlying collection persister (metadata)
        key - The owner key.
        Returns:
        The instantiated collection.

      • nullSafeGet

        public 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 java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                                    java.lang.String[] name,
                                    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.
        name - 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 final 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

      • 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

      • 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)
                  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:
        session - The mapping object :/
        Returns:
        The number of columns
        Throws:
        MappingException - Generally indicates an issue accessing the passed mapping object.

      • 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

      • deepCopy

        public java.lang.Object deepCopy​(java.lang.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.
        Specified by:
        deepCopy in interface Type
        Parameters:
        value - The value to be copied
        factory - The session factory
        Returns:
        The deep copy
        Throws:
        HibernateException - An error from Hibernate

      • 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

      • getElementsIterator

        public java.util.Iterator getElementsIterator​(java.lang.Object collection,
                                              SharedSessionContractImplementor session)
        Get an iterator over the element set of the collection, which may not yet be wrapped
        Parameters:
        collection - The collection to be iterated
        session - The session from which the request is originating.
        Returns:
        The iterator.

      • getElementsIterator

        protected java.util.Iterator getElementsIterator​(java.lang.Object collection)
        Get an iterator over the element set of the collection in POJO mode
        Parameters:
        collection - The collection to be iterated
        Returns:
        The iterator.

      • 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

      • 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

      • isDirty

        public boolean isDirty​(java.lang.Object old,
                       java.lang.Object current,
                       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
        Overrides:
        isDirty in class AbstractType
        Parameters:
        old - the old value
        current - the current value
        session - The session from which the request originated.
        Returns:
        true if the field is dirty
        Throws:
        HibernateException - A problem occurred performing the checking

      • 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

      • wrap

        public abstract PersistentCollection wrap​(SharedSessionContractImplementor session,
                                          java.lang.Object collection)
        Wrap the naked collection instance in a wrapper, or instantiate a holder. Callers MUST add the holder to the persistence context!
        Parameters:
        session - The session from which the request is originating.
        collection - The bare collection to be wrapped.
        Returns:
        The wrapped collection.

      • isAssociationType

        public boolean isAssociationType()
        Note: return true because this type is castable to AssociationType. Not because all collections are associations.
        Specified by:
        isAssociationType in interface Type
        Overrides:
        isAssociationType in class AbstractType
        Returns:
        True if this type is also an AssociationType implementor; false otherwise.

      • getKeyOfOwner

        public java.io.Serializable getKeyOfOwner​(java.lang.Object owner,
                                          SharedSessionContractImplementor session)
        Get the key value from the owning entity instance, usually the identifier, but might be some other unique key, in the case of property-ref
        Parameters:
        owner - The collection owner
        session - The session from which the request is originating.
        Returns:
        The collection owner's key

      • getIdOfOwnerOrNull

        public java.io.Serializable getIdOfOwnerOrNull​(java.io.Serializable key,
                                               SharedSessionContractImplementor session)
        Get the id value from the owning entity key, usually the same as the key, but might be some other property, in the case of property-ref
        Parameters:
        key - The collection owner key
        session - The session from which the request is originating.
        Returns:
        The collection owner's id, if it can be obtained from the key; otherwise, null is returned

      • semiResolve

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

      • isArrayType

        public boolean isArrayType()

      • 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

      • 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

      • replaceElements

        public java.lang.Object replaceElements​(java.lang.Object original,
                                        java.lang.Object target,
                                        java.lang.Object owner,
                                        java.util.Map copyCache,
                                        SharedSessionContractImplementor session)
        Replace the elements of a collection with the elements of another collection.
        Parameters:
        original - The 'source' of the replacement elements (where we copy from)
        target - The target of the replacement elements (where we copy to)
        owner - The owner of the collection being merged
        copyCache - The map of elements already replaced.
        session - The session from which the merge event originated.
        Returns:
        The merged collection.

      • instantiateResult

        protected java.lang.Object instantiateResult​(java.lang.Object original)
        Instantiate a new "underlying" collection exhibiting the same capacity characteristics and the passed "original".
        Parameters:
        original - The original collection.
        Returns:
        The newly instantiated collection.

      • instantiate

        public abstract java.lang.Object instantiate​(int anticipatedSize)
        Instantiate an empty instance of the "underlying" collection (not a wrapper), but with the given anticipated size (i.e. accounting for initial capacity and perhaps load factor).
        Parameters:
        anticipatedSize - The anticipated size of the instantiated collection after we are done populating it.
        Returns:
        A newly instantiated collection to be wrapped.

      • 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

      • getElementType

        public final Type getElementType​(SessionFactoryImplementor factory)
                          throws MappingException
        Get the Hibernate type of the collection elements
        Parameters:
        factory - The session factory.
        Returns:
        The type of the collection elements
        Throws:
        MappingException - Indicates the underlying persister could not be located.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • 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

      • getCollection

        public java.lang.Object getCollection​(java.io.Serializable key,
                                      SharedSessionContractImplementor session,
                                      java.lang.Object owner,
                                      java.lang.Boolean overridingEager)
        instantiate a collection wrapper (called when loading an object)
        Parameters:
        key - The collection owner key
        session - The session from which the request is originating.
        owner - The collection owner
        Returns:
        The collection

      • hasHolder

        public boolean hasHolder()

      • initializeImmediately

        protected boolean initializeImmediately()

      • 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

      • isAlwaysDirtyChecked

        public boolean isAlwaysDirtyChecked()
        We always need to dirty check the collection because we sometimes need to increment version number of owner and also because of how assemble/disassemble is implemented for uks
        Specified by:
        isAlwaysDirtyChecked in interface AssociationType

      • 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