org.hibernate.loader.plan.spi

Class EntityReturn

java.lang.Object

org.hibernate.loader.plan.spi.AbstractPlanNode

org.hibernate.loader.plan.spi.AbstractFetchOwner

org.hibernate.loader.plan.spi.EntityReturn

All Implemented Interfaces:

CopyableReturn, EntityReference, FetchOwner, IdentifierDescriptionInjectable, Return, ResultSetProcessingContext.EntityKeyResolutionContext

public class EntityReturn
extends AbstractFetchOwner
implements Return, EntityReference, CopyableReturn

Represents an entity return value in the query results. Not the same as a result (column) in the JDBC ResultSet!

See Also:

Return

Field Summary

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

NO_FETCHES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityReturn(EntityReturn original, CopyContext copyContext)
	EntityReturn(SessionFactoryImplementor sessionFactory, LockMode lockMode, String entityName) Construct an EntityReturn.

Method Summary

Methods

Modifier and Type	Method and Description
EntityPersister	getEntityPersister() Retrieves the EntityPersister describing the entity associated with this Return.
EntityReference	getEntityReference()
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.
PropertyPath	getPropertyPath() Get the property path to this fetch owner
void	hydrate(ResultSet resultSet, ResultSetProcessingContext context)
void	injectIdentifierDescription(IdentifierDescription identifierDescription)
EntityReturn	makeCopy(CopyContext copyContext) Makes a deep copy.
Object	read(ResultSet resultSet, ResultSetProcessingContext context) Essentially performs the second phase of two-phase loading.
void	resolve(ResultSet resultSet, ResultSetProcessingContext context) Effectively performs first phase of two-phase loading.
EntityPersister	retrieveFetchSourcePersister() Retrieve the EntityPersister that is the base for any property references in the fetches it owns.
String	toString()
void	validateFetchPlan(FetchStrategy fetchStrategy) Is the asserted plan valid from this owner to a fetch?

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

Constructor Detail

EntityReturn

public EntityReturn(SessionFactoryImplementor sessionFactory,
            LockMode lockMode,
            String entityName)

Construct an EntityReturn.

Parameters:

sessionFactory - - the session factory.

lockMode - - the lock mode.

entityName - - the entity name.

EntityReturn

protected EntityReturn(EntityReturn original,
            CopyContext copyContext)

Method Detail

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.

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

validateFetchPlan

public void validateFetchPlan(FetchStrategy fetchStrategy)

Description copied from interface: FetchOwner

Is the asserted plan valid from this owner to a fetch?

Specified by:

validateFetchPlan in interface FetchOwner

Parameters:

fetchStrategy - The pla to validate

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.

getPropertyPath

public PropertyPath getPropertyPath()

Description copied from interface: FetchOwner

Get the property path to this fetch owner

Specified by:

getPropertyPath in interface FetchOwner

Returns:

The property path

hydrate

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

Specified by:

hydrate in interface Return

Throws:

SQLException

resolve

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

Description copied from interface: Return

Effectively performs first phase of two-phase loading. For scalar results first/second phase is one. For entities, first phase is to resolve identifiers; second phase is to resolve the entity instances.

Specified by:

resolve in interface Return

Parameters:

resultSet - The result set being processed

context - The context for the processing

Throws:

SQLException - Indicates a problem access the JDBC result set

read

public Object read(ResultSet resultSet,
          ResultSetProcessingContext context)
            throws SQLException

Description copied from interface: Return

Essentially performs the second phase of two-phase loading.

Specified by:

read in interface Return

Parameters:

resultSet - The result set being processed

context - The context for the processing

Returns:

The read object

Throws:

SQLException - Indicates a problem access the JDBC result set

injectIdentifierDescription

public void injectIdentifierDescription(IdentifierDescription identifierDescription)

Specified by:

injectIdentifierDescription in interface IdentifierDescriptionInjectable

toString

public String toString()

Overrides:

toString in class Object

makeCopy

public EntityReturn makeCopy(CopyContext copyContext)

Description copied from interface: CopyableReturn

Makes a deep copy.

Specified by:

makeCopy in interface CopyableReturn

Returns:

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