Top Description Fields Constructors Methods
org.hibernate.loader

public abstract Class OuterJoinLoader

extends BasicLoader
Class Inheritance
Known Direct Subclasses
org.hibernate.loader.collection.CollectionLoader, org.hibernate.loader.criteria.CriteriaLoader, org.hibernate.loader.entity.AbstractEntityLoader, org.hibernate.loader.entity.CollectionElementLoader
Imports
org.hibernate.LockMode, .LockOptions, org.hibernate.dialect.Dialect, org.hibernate.engine.spi.LoadQueryInfluencers, .SessionFactoryImplementor, org.hibernate.persister.collection.CollectionPersister, org.hibernate.persister.entity.Loadable, org.hibernate.type.EntityType
Implements logic for walking a tree of associated classes. Generates an SQL select string containing all properties of those classes. Tables are joined using an ANSI-style left outer join.
Author
Gavin King

Field Summary

Modifier and TypeField and Description
protected String[]
aliases

protected int[]
collectionOwners

protected CollectionPersister[]
collectionPersisters

protected String[]
collectionSuffixes

private LoadQueryInfluencers
loadQueryInfluencers

protected LockMode[]
lockModeArray

private LockOptions
lockOptions

protected EntityType[]
ownerAssociationTypes

protected int[]
owners

protected Loadable[]
persisters

protected String
sql

protected String[]
suffixes

Inherited from org.hibernate.loader.BasicLoader:
NO_SUFFIX

Constructor Summary

AccessConstructor and Description
public
OuterJoinLoader(SessionFactoryImplementor factory, LoadQueryInfluencers loadQueryInfluencers)

Deprecated as a consequence of SessionFactoryImplementor being deprecated.

Method Summary

Modifier and TypeMethod and Description
protected final String[]
getAliases()

Overrides org.hibernate.loader.Loader.getAliases.

Get the SQL table aliases of entities whose associations are subselect-loadable, returning null if this loader does not support subselect loading
protected final int[]
getCollectionOwners()

Overrides org.hibernate.loader.Loader.getCollectionOwners.

Get the index of the entity that owns the collection, or -1 if there is no owner in the query results (ie.
public final CollectionPersister[]
getCollectionPersisters()

Overrides org.hibernate.loader.Loader.getCollectionPersisters.

An (optional) persister for a collection to be initialized; only collection loaders return a non-null value
protected String[]
getCollectionSuffixes()

Implements abstract org.hibernate.loader.BasicLoader.getCollectionSuffixes.

protected final Dialect
getDialect()

public final Loadable[]
getEntityPersisters()

Implements abstract org.hibernate.loader.Loader.getEntityPersisters.

An array of persisters of entity classes contained in each row of results; implemented by all subclasses
public LoadQueryInfluencers
getLoadQueryInfluencers()

protected LockMode[]
getLockModes(LockOptions
a collection of lock options specified dynamically via the Query interface
lockOptions)

Implements abstract org.hibernate.loader.Loader.getLockModes.

What lock options does this load entities with?
protected LockOptions
getLockOptions()

protected EntityType[]
getOwnerAssociationTypes()

Overrides org.hibernate.loader.Loader.getOwnerAssociationTypes.

An array of the owner types corresponding to the getOwners() returns.
protected int[]
getOwners()

Overrides org.hibernate.loader.Loader.getOwners.

An array of indexes of the entity that owns a one-to-one association to the entity at the given index (-1 if there is no "owner").
public final String
getSQLString()

Implements abstract org.hibernate.loader.Loader.getSQLString.

The SQL query string to be called; implemented by all subclasses
protected String[]
getSuffixes()

Implements abstract org.hibernate.loader.BasicLoader.getSuffixes.

protected void
initFromWalker(JoinWalker walker)

Inherited from org.hibernate.loader.BasicLoader:
generateSuffixesgenerateSuffixesgetCollectionAliasesgetEntityAliasespostInstantiate

Field Detail

aliasesback to summary
protected String[] aliases
collectionOwnersback to summary
protected int[] collectionOwners
collectionPersistersback to summary
protected CollectionPersister[] collectionPersisters
collectionSuffixesback to summary
protected String[] collectionSuffixes
loadQueryInfluencersback to summary
private LoadQueryInfluencers loadQueryInfluencers
lockModeArrayback to summary
protected LockMode[] lockModeArray
lockOptionsback to summary
private LockOptions lockOptions
ownerAssociationTypesback to summary
protected EntityType[] ownerAssociationTypes
ownersback to summary
protected int[] owners
persistersback to summary
protected Loadable[] persisters
sqlback to summary
protected String sql
suffixesback to summary
protected String[] suffixes

Constructor Detail

OuterJoinLoaderback to summary
public OuterJoinLoader(SessionFactoryImplementor factory, LoadQueryInfluencers loadQueryInfluencers)

Deprecated

as a consequence of SessionFactoryImplementor being deprecated. See corresponding docs for further information.

Method Detail

getAliasesback to summary
protected final String[] getAliases()

Overrides org.hibernate.loader.Loader.getAliases.

Doc from org.hibernate.loader.Loader.getAliases.

Get the SQL table aliases of entities whose associations are subselect-loadable, returning null if this loader does not support subselect loading

getCollectionOwnersback to summary
protected final int[] getCollectionOwners()

Overrides org.hibernate.loader.Loader.getCollectionOwners.

Doc from org.hibernate.loader.Loader.getCollectionOwners.

Get the index of the entity that owns the collection, or -1 if there is no owner in the query results (ie. in the case of a collection initializer) or no collection.

getCollectionPersistersback to summary
public final CollectionPersister[] getCollectionPersisters()

Overrides org.hibernate.loader.Loader.getCollectionPersisters.

Doc from org.hibernate.loader.Loader.getCollectionPersisters.

An (optional) persister for a collection to be initialized; only collection loaders return a non-null value

getCollectionSuffixesback to summary
protected String[] getCollectionSuffixes()

Implements abstract org.hibernate.loader.BasicLoader.getCollectionSuffixes.

getDialectback to summary
protected final Dialect getDialect()
getEntityPersistersback to summary
public final Loadable[] getEntityPersisters()

Implements abstract org.hibernate.loader.Loader.getEntityPersisters.

Doc from org.hibernate.loader.Loader.getEntityPersisters.

An array of persisters of entity classes contained in each row of results; implemented by all subclasses

Returns:Loadable[]

The entity persisters.

getLoadQueryInfluencersback to summary
public LoadQueryInfluencers getLoadQueryInfluencers()
getLockModesback to summary
protected LockMode[] getLockModes(LockOptions lockOptions)

Implements abstract org.hibernate.loader.Loader.getLockModes.

Doc from org.hibernate.loader.Loader.getLockModes.

What lock options does this load entities with?

Parameters
lockOptions:LockOptions

a collection of lock options specified dynamically via the Query interface

getLockOptionsback to summary
protected LockOptions getLockOptions()
getOwnerAssociationTypesback to summary
protected EntityType[] getOwnerAssociationTypes()

Overrides org.hibernate.loader.Loader.getOwnerAssociationTypes.

Doc from org.hibernate.loader.Loader.getOwnerAssociationTypes.

An array of the owner types corresponding to the getOwners() returns. Indices indicating no owner would be null here.

Returns:EntityType[]

The types for the owners.

getOwnersback to summary
protected int[] getOwners()

Overrides org.hibernate.loader.Loader.getOwners.

Doc from org.hibernate.loader.Loader.getOwners.

An array of indexes of the entity that owns a one-to-one association to the entity at the given index (-1 if there is no "owner"). The indexes contained here are relative to the result of getEntityPersisters.

Returns:int[]

The owner indicators (see discussion above).

getSQLStringback to summary
public final String getSQLString()

Implements abstract org.hibernate.loader.Loader.getSQLString.

Doc from org.hibernate.loader.Loader.getSQLString.

The SQL query string to be called; implemented by all subclasses

Returns:String

The sql command this loader should use to get its ResultSet.

Annotations
@Override
getSuffixesback to summary
protected String[] getSuffixes()

Implements abstract org.hibernate.loader.BasicLoader.getSuffixes.

initFromWalkerback to summary
protected void initFromWalker(JoinWalker walker)