org.hibernate.loader.plan.spi

Class EntityFetch

java.lang.Object

org.hibernate.loader.plan.spi.AbstractPlanNode

org.hibernate.loader.plan.spi.AbstractFetchOwner

org.hibernate.loader.plan.spi.AbstractSingularAttributeFetch

org.hibernate.loader.plan.spi.EntityFetch

All Implemented Interfaces:

CopyableFetch, EntityReference, Fetch, FetchOwner, IdentifierDescriptionInjectable, ResultSetProcessingContext.EntityKeyResolutionContext

public class EntityFetch
extends AbstractSingularAttributeFetch
implements EntityReference, Fetch

Represents a Fetch for an entity association attribute as well as a FetchOwner of the entity association sub-attribute fetches.

Field Summary

Fields inherited from interface org.hibernate.loader.plan.spi.FetchOwner

NO_FETCHES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityFetch(EntityFetch original, CopyContext copyContext, FetchOwner fetchOwnerCopy) Copy constructor.
	EntityFetch(SessionFactoryImplementor sessionFactory, LockMode lockMode, FetchOwner owner, String ownerProperty, FetchStrategy fetchStrategy) Constructs an EntityFetch object.

Method Summary

Methods

Modifier and Type	Method and Description
EntityPersister	getEntityPersister() Retrieves the EntityPersister describing the entity associated with this Return.
EntityReference	getEntityReference()
EntityType	getEntityType() Returns the entity type for this fetch.
protected FetchOwnerDelegate	getFetchOwnerDelegate() Abstract method returning the delegate for obtaining details about an owned fetch.
IdentifierDescription	getIdentifierDescription()
LockMode	getLockMode() Retrieve the lock mode associated with this return.
void	hydrate(ResultSet resultSet, ResultSetProcessingContext context)
void	injectIdentifierDescription(IdentifierDescription identifierDescription)
EntityFetch	makeCopy(CopyContext copyContext, FetchOwner fetchOwnerCopy)
EntityKey	resolve(ResultSet resultSet, ResultSetProcessingContext context)
EntityKey	resolveInIdentifier(ResultSet resultSet, ResultSetProcessingContext context) Resolve any fetches required to resolve the identifier as well as the entity key for this fetch..
EntityPersister	retrieveFetchSourcePersister() Retrieve the EntityPersister that is the base for any property references in the fetches it owns.
String	toString()

Methods inherited from class org.hibernate.loader.plan.spi.AbstractSingularAttributeFetch

getColumnNames, getFetchStrategy, getOwner, getOwnerPropertyName, getPropertyPath, isNullable, validateFetchPlan

Methods inherited from class org.hibernate.loader.plan.spi.AbstractFetchOwner

addFetch, buildCollectionFetch, buildCompositeFetch, buildEntityFetch, getColumnNames, getFetches, getType, isNullable

Methods inherited from class org.hibernate.loader.plan.spi.AbstractPlanNode

sessionFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.loader.plan.spi.Fetch

getColumnNames, getFetchStrategy, getOwner, getOwnerPropertyName, getPropertyPath, isNullable

Constructor Detail

EntityFetch

public EntityFetch(SessionFactoryImplementor sessionFactory,
           LockMode lockMode,
           FetchOwner owner,
           String ownerProperty,
           FetchStrategy fetchStrategy)

Constructs an EntityFetch object.

Parameters:

sessionFactory - - the session factory.

lockMode - - the lock mode.

owner - - the fetch owner for this fetch.

ownerProperty - - the owner's property referring to this fetch.

fetchStrategy - - the fetch strategy for this fetch.

EntityFetch

protected EntityFetch(EntityFetch original,
           CopyContext copyContext,
           FetchOwner fetchOwnerCopy)

Copy constructor.

Parameters:

original - The original fetch

copyContext - Access to contextual needs for the copy operation

Method Detail

getEntityType

public final EntityType getEntityType()

Returns the entity type for this fetch.

Returns:

the entity type for this fetch.

getEntityReference

public EntityReference getEntityReference()

Specified by:

getEntityReference in interface ResultSetProcessingContext.EntityKeyResolutionContext

getEntityPersister

public EntityPersister getEntityPersister()

Description copied from interface: EntityReference

Retrieves the EntityPersister describing the entity associated with this Return.

Specified by:

getEntityPersister in interface EntityReference

Specified by:

getEntityPersister in interface ResultSetProcessingContext.EntityKeyResolutionContext

Returns:

The EntityPersister.

getIdentifierDescription

public IdentifierDescription getIdentifierDescription()

Specified by:

getIdentifierDescription in interface EntityReference

getLockMode

public LockMode getLockMode()

Description copied from interface: EntityReference

Retrieve the lock mode associated with this return.

Specified by:

getLockMode in interface EntityReference

Specified by:

getLockMode in interface ResultSetProcessingContext.EntityKeyResolutionContext

Returns:

The lock mode.

retrieveFetchSourcePersister

public EntityPersister retrieveFetchSourcePersister()

Description copied from interface: FetchOwner

Retrieve the EntityPersister that is the base for any property references in the fetches it owns.

Specified by:

retrieveFetchSourcePersister in interface FetchOwner

Returns:

The EntityPersister, for property name resolution.

injectIdentifierDescription

public void injectIdentifierDescription(IdentifierDescription identifierDescription)

Specified by:

injectIdentifierDescription in interface IdentifierDescriptionInjectable

hydrate

public void hydrate(ResultSet resultSet,
           ResultSetProcessingContext context)
             throws SQLException

Specified by:

hydrate in interface Fetch

Throws:

SQLException

resolve

public EntityKey resolve(ResultSet resultSet,
                ResultSetProcessingContext context)
                  throws SQLException

Specified by:

resolve in interface Fetch

Throws:

SQLException

resolveInIdentifier

public EntityKey resolveInIdentifier(ResultSet resultSet,
                            ResultSetProcessingContext context)
                              throws SQLException

Resolve any fetches required to resolve the identifier as well as the entity key for this fetch..

Parameters:

resultSet - - the result set.

context - - the result set processing context.

Returns:

the entity key for this fetch.

Throws:

SQLException

toString

public String toString()

Overrides:

toString in class AbstractSingularAttributeFetch

makeCopy

public EntityFetch makeCopy(CopyContext copyContext,
                   FetchOwner fetchOwnerCopy)

Specified by:

makeCopy in interface CopyableFetch

Specified by:

makeCopy in interface Fetch

getFetchOwnerDelegate

protected FetchOwnerDelegate getFetchOwnerDelegate()

Description copied from class: AbstractFetchOwner

Abstract method returning the delegate for obtaining details about an owned fetch.

Specified by:

getFetchOwnerDelegate in class AbstractFetchOwner

Returns:

the delegate