Top Description Methods
org.hibernate.persister.collection

public Interface QueryableCollection

extends PropertyMapping, Joinable, CollectionPersister
Known Direct Subinterfaces
org.hibernate.persister.collection.SQLLoadableCollection
Imports
org.hibernate.FetchMode, org.hibernate.persister.entity.EntityPersister, .Joinable, .PropertyMapping

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

Method Summary

Modifier and TypeMethod and Description
public String[]
getElementColumnNames(String alias)

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

public String[]
getElementColumnNames()

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

public EntityPersister
getElementPersister()

Get the persister of the element class, if this is a collection of entities (optional operation).

public FetchMode
getFetchMode()

Should we load this collection role by outerjoining?

public String[]
getIndexColumnNames()

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

public String[]
getIndexColumnNames(String alias)

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

public String[]
getIndexFormulas()

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

public String

Returns:

appropriate order-by fragment or empty string.
getManyToManyOrderByString
(String
The alias for the many-to-many target table
alias
)

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

public String
getSQLOrderByString(String alias)

Get the order by SQL

public boolean
hasWhere()

Does this collection role have a where clause filter?

public String
selectFragment(String alias, String columnSuffix)

Generate a list of collection index and element columns

Inherited from org.hibernate.persister.collection.CollectionPersister:
deleteRowselementExistsgetBatchSizegetCacheAccessStrategygetCacheEntryStructuregetCollectionMetadatagetCollectionSpacesgetCollectionTypegetElementByIndexgetElementClassgetElementColumnAliasesgetElementTypegetFactorygetIdentifierColumnAliasgetIdentifierGeneratorgetIdentifierTypegetIndexColumnAliasesgetIndexTypegetKeyColumnAliasesgetKeyTypegetManyToManyFilterFragmentgetMappedByPropertygetNavigableRolegetOwnerEntityPersistergetRolegetSizehasCachehasIndexhasManyToManyOrderinghasOrderinghasOrphanDeleteindexExistsinitializeinsertRowsisAffectedByEnabledFiltersisArrayisCascadeDeleteEnabledisExtraLazyisInverseisLazyisManyToManyisMutableisOneToManyisPrimitiveArrayisVersionedpostInstantiateprocessQueuedOpsreadElementreadIdentifierreadIndexreadKeyrecreateremoveupdateRows
Inherited from org.hibernate.persister.entity.Joinable:
consumesCollectionAliasconsumesEntityAliasfilterFragmentfilterFragmentfromJoinFragmentfromJoinFragmentfromJoinFragmentgetKeyColumnNamesgetNamegetTableNameisCollectiononeToManyFilterFragmentoneToManyFilterFragmentselectFragmentwhereJoinFragmentwhereJoinFragment
Inherited from org.hibernate.persister.entity.PropertyMapping:
getTypetoColumnstoColumnstoType

Method Detail

getElementColumnNamesback to summary
public String[] getElementColumnNames(String alias)

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

getElementColumnNamesback to summary
public String[] getElementColumnNames()

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

getElementPersisterback to summary
public EntityPersister getElementPersister()

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.

getFetchModeback to summary
public FetchMode getFetchMode()

Should we load this collection role by outerjoining?

getIndexColumnNamesback to summary
public String[] getIndexColumnNames()

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

getIndexColumnNamesback to summary
public String[] getIndexColumnNames(String alias)

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

getIndexFormulasback to summary
public String[] getIndexFormulas()

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

getManyToManyOrderByStringback to summary
public String getManyToManyOrderByString(String alias)

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

Parameters
alias:String

The alias for the many-to-many target table

Returns:String

appropriate order-by fragment or empty string.

getSQLOrderByStringback to summary
public String getSQLOrderByString(String alias)

Get the order by SQL

hasWhereback to summary
public boolean hasWhere()

Does this collection role have a where clause filter?

selectFragmentback to summary
public String selectFragment(String alias, String columnSuffix)

Generate a list of collection index and element columns