Interface CollectionPersister

    • Method Detail

      • hasCache

        boolean hasCache()
        Is this collection role cacheable
      • getKeyType

        Type getKeyType()
        Get the "key" type (the type of the foreign key)
      • getIndexType

        Type getIndexType()
        Get the "index" type for a list or map (optional operation)
      • getElementType

        Type getElementType()
        Get the "element" type
      • getElementClass

        Class getElementClass()
        Return the element class of an array, or null otherwise
      • getElementConverter

        default BasicValueConverter getElementConverter()
        The value converter for the element values of this collection
      • getIndexConverter

        default BasicValueConverter getIndexConverter()
        The value converter for index values of this collection (effectively map keys only)
      • isPrimitiveArray

        boolean isPrimitiveArray()
        Is this an array or primitive values?
      • isArray

        boolean isArray()
        Is this an array?
      • isOneToMany

        boolean isOneToMany()
        Is this a one-to-many association?
      • isManyToMany

        boolean isManyToMany()
        Is this a many-to-many association? Note that this is mainly a convenience feature as the single persister does not contain all the information needed to handle a many-to-many itself, as internally it is looked at as two many-to-ones.
      • hasIndex

        boolean hasIndex()
        Is this an "indexed" collection? (list or map)
      • isLazy

        boolean isLazy()
        Is this collection lazyily initialized?
      • isInverse

        boolean isInverse()
        Is this collection "inverse", so state changes are not propagated to the database.
      • getRole

        String getRole()
        Get the name of this collection role (the fully qualified class name, extended by a "property path")
      • getOwnerEntityPersister

        EntityPersister getOwnerEntityPersister()
        Get the persister of the entity that "owns" this collection
      • getIdentifierGenerator

        IdentifierGenerator getIdentifierGenerator()
        Get the surrogate key generation strategy (optional operation)
      • getIdentifierType

        Type getIdentifierType()
        Get the type of the surrogate key
      • hasOrphanDelete

        boolean hasOrphanDelete()
        Does this collection implement "orphan delete"?
      • hasOrdering

        boolean hasOrdering()
        Is this an ordered collection? (An ordered collection is ordered by the initialization operation, not by sorting that happens in memory, as in the case of a sorted collection.)
      • hasManyToManyOrdering

        boolean hasManyToManyOrdering()
      • getCollectionSpaces

        Serializable[] getCollectionSpaces()
        Get the "space" that holds the persistent state
      • isCascadeDeleteEnabled

        boolean isCascadeDeleteEnabled()
        Is cascade delete handled by the database-level foreign key constraint definition?
      • isVersioned

        boolean isVersioned()
        Does this collection cause version increment of the owning entity?
      • isMutable

        boolean isMutable()
        Can the elements of this collection change?
      • isAffectedByEnabledFilters

        default boolean isAffectedByEnabledFilters​(LoadQueryInfluencers influencers)
      • isAffectedByEntityGraph

        default boolean isAffectedByEntityGraph​(LoadQueryInfluencers influencers)
      • isAffectedByEnabledFetchProfiles

        default boolean isAffectedByEnabledFetchProfiles​(LoadQueryInfluencers influencers)
      • getKeyColumnAliases

        String[] getKeyColumnAliases​(String suffix)
        Generates the collection's key column aliases, based on the given suffix.
        Parameters:
        suffix - The suffix to use in the key column alias generation.
        Returns:
        The key column aliases.
      • getIndexColumnAliases

        String[] getIndexColumnAliases​(String suffix)
        Generates the collection's index column aliases, based on the given suffix.
        Parameters:
        suffix - The suffix to use in the index column alias generation.
        Returns:
        The key column aliases, or null if not indexed.
      • getElementColumnAliases

        String[] getElementColumnAliases​(String suffix)
        Generates the collection's element column aliases, based on the given suffix.
        Parameters:
        suffix - The suffix to use in the element column alias generation.
        Returns:
        The key column aliases.
      • getIdentifierColumnAlias

        String getIdentifierColumnAlias​(String suffix)
        Generates the collection's identifier column aliases, based on the given suffix.
        Parameters:
        suffix - The suffix to use in the key column alias generation.
        Returns:
        The key column aliases.
      • isExtraLazy

        boolean isExtraLazy()
      • getBatchSize

        int getBatchSize()
      • getMappedByProperty

        String getMappedByProperty()
        Returns:
        the name of the property this collection is mapped by