Package org.hibernate.persister.collection

Interface QueryableCollection

All Superinterfaces:

CollectionPersister, FilterRestrictable, Joinable, PropertyMapping, Restrictable, WhereRestrictable

All Known Subinterfaces:

DeprecatedCollectionStuff, SQLLoadableCollection

All Known Implementing Classes:

AbstractCollectionPersister, BasicCollectionPersister, OneToManyPersister

@Deprecated(since="6",
            forRemoval=true)
public interface QueryableCollection
extends PropertyMapping, Joinable, CollectionPersister

Deprecated, for removal: This API element is subject to removal in a future version.

Given the mapping-model and SQM, this contract is no longer needed. Note however that SQLQueryParser currently uses this along with other

A collection role that may be queried or loaded by outer join.

Author:

Gavin King

Method Summary

Modifier and Type	Method	Description
String[]	getElementColumnNames()	Deprecated, for removal: This API element is subject to removal in a future version. Get the names of the collection element columns (or the primary key columns in the case of a one-to-many association)
String[]	getElementColumnNames(String alias)	Deprecated, for removal: This API element is subject to removal in a future version. Get the names of the collection element columns (or the primary key columns in the case of a one-to-many association), aliased by the given table alias
EntityPersister	getElementPersister()	Deprecated, for removal: This API element is subject to removal in a future version. Get the persister of the element class, if this is a collection of entities (optional operation).
FetchMode	getFetchMode()	Deprecated, for removal: This API element is subject to removal in a future version. Should we load this collection role by outerjoining?
String[]	getIndexColumnNames()	Deprecated, for removal: This API element is subject to removal in a future version. Get the names of the collection index columns if this is an indexed collection (optional operation)
String[]	getIndexColumnNames(String alias)	Deprecated, for removal: This API element is subject to removal in a future version. Get the names of the collection index columns if this is an indexed collection (optional operation), aliased by the given table alias
String[]	getIndexFormulas()	Deprecated, for removal: This API element is subject to removal in a future version. Get the index formulas if this is an indexed collection (optional operation)
String	getManyToManyOrderByString(String alias)	Deprecated, for removal: This API element is subject to removal in a future version. Get the order-by to be applied at the target table of a many to many
String	getSQLOrderByString(String alias)	Deprecated, for removal: This API element is subject to removal in a future version. Get the order by SQL
boolean	hasWhere()	Deprecated, for removal: This API element is subject to removal in a future version. Does this collection role have a where clause filter?
String	selectFragment(String alias, String columnSuffix)	Deprecated, for removal: This API element is subject to removal in a future version. Generate a list of collection index and element columns

Methods inherited from interface org.hibernate.persister.collection.CollectionPersister

applyBaseManyToManyRestrictions, deleteRows, elementExists, getAttributeMapping, getBatchSize, getCacheAccessStrategy, getCacheEntryStructure, getCollectionMetadata, getCollectionSemantics, getCollectionSpaces, getCollectionType, getElementByIndex, getElementClass, getElementColumnAliases, getElementType, getFactory, getGenerator, getIdentifierColumnAlias, getIdentifierGenerator, getIdentifierType, getIndexColumnAliases, getIndexType, getKeyColumnAliases, getKeyType, getManyToManyFilterFragment, getMappedByProperty, getNavigableRole, getOwnerEntityPersister, getRole, getSize, getSortingComparator, hasCache, hasIndex, hasManyToManyOrdering, hasOrdering, hasOrphanDelete, indexExists, initialize, insertRows, isAffectedByEnabledFetchProfiles, isAffectedByEnabledFilters, isAffectedByEnabledFilters, isAffectedByEnabledFilters, isAffectedByEnabledFilters, isAffectedByEntityGraph, isArray, isBatchLoadable, isCascadeDeleteEnabled, isExtraLazy, isInverse, isLazy, isManyToMany, isMutable, isOneToMany, isPrimitiveArray, isSubselectLoadable, isVersioned, needsRemove, postInstantiate, processQueuedOps, recreate, remove, updateRows, useShallowQueryCacheLayout

Methods inherited from interface org.hibernate.metamodel.mapping.FilterRestrictable

applyFilterRestrictions, applyFilterRestrictions

Methods inherited from interface org.hibernate.persister.entity.Joinable

consumesCollectionAlias, consumesEntityAlias, getKeyColumnNames, getName, getTableName, isCollection

Methods inherited from interface org.hibernate.persister.entity.PropertyMapping

toColumns, toType

Methods inherited from interface org.hibernate.metamodel.mapping.Restrictable

applyBaseRestrictions, applyBaseRestrictions

Methods inherited from interface org.hibernate.metamodel.mapping.WhereRestrictable

applyWhereRestrictions, hasWhereRestrictions

Method Details

selectFragment

String selectFragment(String alias,
 String columnSuffix)

Deprecated, for removal: This API element is subject to removal in a future version.

Generate a list of collection index and element columns

getIndexColumnNames

String[] getIndexColumnNames()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the names of the collection index columns if this is an indexed collection (optional operation)

getIndexFormulas

String[] getIndexFormulas()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the index formulas if this is an indexed collection (optional operation)

getIndexColumnNames

String[] getIndexColumnNames(String alias)

Deprecated, for removal: This API element is subject to removal in a future version.

Get the names of the collection index columns if this is an indexed collection (optional operation), aliased by the given table alias

getElementColumnNames

String[] getElementColumnNames(String alias)

Deprecated, for removal: This API element is subject to removal in a future version.

Get the names of the collection element columns (or the primary key columns in the case of a one-to-many association), aliased by the given table alias

getElementColumnNames

String[] getElementColumnNames()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the names of the collection element columns (or the primary key columns in the case of a one-to-many association)

getSQLOrderByString

String getSQLOrderByString(String alias)

Deprecated, for removal: This API element is subject to removal in a future version.

Get the order by SQL

getManyToManyOrderByString

String getManyToManyOrderByString(String alias)

Deprecated, for removal: This API element is subject to removal in a future version.

Get the order-by to be applied at the target table of a many to many

Parameters:

alias - The alias for the many-to-many target table

Returns:

appropriate order-by fragment or empty string.

hasWhere

boolean hasWhere()

Deprecated, for removal: This API element is subject to removal in a future version.

Does this collection role have a where clause filter?

getElementPersister

EntityPersister getElementPersister()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the persister of the element class, if this is a collection of entities (optional operation). Note that for a one-to-many association, the returned persister must be OuterJoinLoadable.

getFetchMode

FetchMode getFetchMode()

Deprecated, for removal: This API element is subject to removal in a future version.

Should we load this collection role by outerjoining?