QueryableCollection (Hibernate API Documentation) - Hibernate 2.1.8 正式版 API 英文文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.hibernate.collection
Interface QueryableCollection

All Superinterfaces:: CollectionPersister, Joinable, PropertyMapping

All Known Implementing Classes:: AbstractCollectionPersister

public interface QueryableCollection
extends PropertyMapping, Joinable, CollectionPersister

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

Author:: Gavin King

Method Summary

int enableJoinedFetch()
          Should we load this collection role by outerjoining?

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

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

String[] getIndexColumnNames()
          Get the names of the collection index columnsm if this is an indexed collection (optional operation)

String[] getKeyColumnNames()
          Get the names of the collection key columns

String getSQLOrderByString(String alias)
          Get the order by SQL

String getSQLWhereString(String alias)
          Get the extra where clause filter SQL

boolean hasWhere()
          Does this collection role have a where clause filter?

String selectFragment(String alias)
          Generate a list of collection index and element columns

Methods inherited from interface net.sf.hibernate.persister.PropertyMapping

getType, toColumns, toType

Methods inherited from interface net.sf.hibernate.persister.Joinable

consumesAlias, fromJoinFragment, getJoinKeyColumnNames, getName, getTableName, isCollection, isManyToMany, selectFragment, whereJoinFragment

Methods inherited from interface net.sf.hibernate.collection.CollectionPersister

deleteRows, getCache, getCollectionMetadata, getCollectionSpace, getCollectionType, getElementClass, getElementType, getIdentifierGenerator, getIdentifierType, getIndexType, getKeyType, getOwnerClass, getRole, hasCache, hasIndex, hasOrdering, hasOrphanDelete, initialize, insertRows, isArray, isInverse, isLazy, isOneToMany, isPrimitiveArray, readElement, readIdentifier, readIndex, readKey, recreate, remove, updateRows, writeElement, writeIdentifier, writeIndex, writeKey

Method Detail

selectFragment

public String selectFragment(String alias)

Generate a list of collection index and element columns

getIndexColumnNames

public String[] getIndexColumnNames()

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

getElementColumnNames

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)

getKeyColumnNames

public String[] getKeyColumnNames()

Get the names of the collection key columns

getSQLWhereString

public String getSQLWhereString(String alias)

Get the extra where clause filter SQL

getSQLOrderByString

public String getSQLOrderByString(String alias)

Get the order by SQL

hasWhere

public boolean hasWhere()

Does this collection role have a where clause filter?

getElementPersister

public ClassPersister 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.

enableJoinedFetch

public int enableJoinedFetch()

Should we load this collection role by outerjoining?