org.hibernate.loader.plan.build.internal

Class FetchStyleLoadPlanBuildingAssociationVisitationStrategy

java.lang.Object

org.hibernate.loader.plan.build.internal.AbstractLoadPlanBuildingAssociationVisitationStrategy

org.hibernate.loader.plan.build.internal.FetchStyleLoadPlanBuildingAssociationVisitationStrategy

All Implemented Interfaces:

LoadPlanBuildingAssociationVisitationStrategy, LoadPlanBuildingContext, AssociationVisitationStrategy

Direct Known Subclasses:

CascadeStyleLoadPlanBuildingAssociationVisitationStrategy

public class FetchStyleLoadPlanBuildingAssociationVisitationStrategy
extends AbstractLoadPlanBuildingAssociationVisitationStrategy

LoadPlanBuildingAssociationVisitationStrategy implementation used for building LoadPlans based on metamodel-defined fetching. Built LoadPlans contain a single root return object, either an EntityReturn or a CollectionReturn.

Author:

Steve Ebersole

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.loader.plan.build.internal.AbstractLoadPlanBuildingAssociationVisitationStrategy

AbstractLoadPlanBuildingAssociationVisitationStrategy.PropertyPathStack

Field Summary

Fields inherited from class org.hibernate.loader.plan.build.internal.AbstractLoadPlanBuildingAssociationVisitationStrategy

currentPropertyPath

Constructor Summary

Constructors

Constructor and Description
FetchStyleLoadPlanBuildingAssociationVisitationStrategy(SessionFactoryImplementor sessionFactory, LoadQueryInfluencers loadQueryInfluencers, LockMode lockMode) Constructs a FetchStyleLoadPlanBuildingAssociationVisitationStrategy.

Method Summary

Modifier and Type	Method and Description
protected void	addRootReturn(Return rootReturn)
protected FetchStrategy	adjustJoinFetchIfNeeded(AssociationAttributeDefinition attributeDefinition, FetchStrategy fetchStrategy) If required by this strategy, returns a different FetchStrategy from what is specified for the given association attribute.
LoadPlan	buildLoadPlan() After visitation is done, build the load plan.
protected FetchStrategy	determineFetchStrategy(AssociationAttributeDefinition attributeDefinition)
void	finishingEntityIdentifier(EntityIdentifierDefinition identifierDefinition) Notification we are finishing walking an entity.
protected boolean	handleAssociationAttribute(AssociationAttributeDefinition attributeDefinition)
protected boolean	isTooManyCollections()
void	startingEntityIdentifier(EntityIdentifierDefinition identifierDefinition) Notification we are starting to walk the identifier of an entity.
protected boolean	supportsRootCollectionReturns()
protected boolean	supportsRootEntityReturns()

Methods inherited from class org.hibernate.loader.plan.build.internal.AbstractLoadPlanBuildingAssociationVisitationStrategy

associationKeyRegistered, currentDepth, currentSource, finish, finishingAttribute, finishingCollection, finishingCollectionElements, finishingCollectionIndex, finishingComposite, finishingEntity, foundAny, foundCircularAssociation, getQuerySpaces, getSessionFactory, handleCompositeAttribute, isDuplicateAssociationKey, registeredFetchSource, sessionFactory, start, startingAttribute, startingCollection, startingCollectionElements, startingCollectionIndex, startingComposite, startingEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

FetchStyleLoadPlanBuildingAssociationVisitationStrategy

public FetchStyleLoadPlanBuildingAssociationVisitationStrategy(SessionFactoryImplementor sessionFactory,
                                                               LoadQueryInfluencers loadQueryInfluencers,
                                                               LockMode lockMode)

Constructs a FetchStyleLoadPlanBuildingAssociationVisitationStrategy.

Parameters:

sessionFactory - The session factory

loadQueryInfluencers - The options which can influence the SQL query needed to perform the load.

lockMode - The lock mode.

Method Detail

supportsRootEntityReturns

protected boolean supportsRootEntityReturns()

Overrides:

supportsRootEntityReturns in class AbstractLoadPlanBuildingAssociationVisitationStrategy

supportsRootCollectionReturns

protected boolean supportsRootCollectionReturns()

Overrides:

supportsRootCollectionReturns in class AbstractLoadPlanBuildingAssociationVisitationStrategy

addRootReturn

protected void addRootReturn(Return rootReturn)

Specified by:

addRootReturn in class AbstractLoadPlanBuildingAssociationVisitationStrategy

startingEntityIdentifier

public void startingEntityIdentifier(EntityIdentifierDefinition identifierDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification we are starting to walk the identifier of an entity.

Specified by:

startingEntityIdentifier in interface AssociationVisitationStrategy

Overrides:

startingEntityIdentifier in class AbstractLoadPlanBuildingAssociationVisitationStrategy

Parameters:

identifierDefinition - The identifier we are preparing to walk

finishingEntityIdentifier

public void finishingEntityIdentifier(EntityIdentifierDefinition identifierDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification we are finishing walking an entity.

Specified by:

finishingEntityIdentifier in interface AssociationVisitationStrategy

Overrides:

finishingEntityIdentifier in class AbstractLoadPlanBuildingAssociationVisitationStrategy

Parameters:

identifierDefinition - The identifier we are finishing walking.

handleAssociationAttribute

protected boolean handleAssociationAttribute(AssociationAttributeDefinition attributeDefinition)

Overrides:

handleAssociationAttribute in class AbstractLoadPlanBuildingAssociationVisitationStrategy

buildLoadPlan

public LoadPlan buildLoadPlan()

Description copied from interface: LoadPlanBuildingAssociationVisitationStrategy

After visitation is done, build the load plan.

Returns:

The load plan

determineFetchStrategy

protected FetchStrategy determineFetchStrategy(AssociationAttributeDefinition attributeDefinition)

Specified by:

determineFetchStrategy in class AbstractLoadPlanBuildingAssociationVisitationStrategy

adjustJoinFetchIfNeeded

protected FetchStrategy adjustJoinFetchIfNeeded(AssociationAttributeDefinition attributeDefinition,
                                                FetchStrategy fetchStrategy)

If required by this strategy, returns a different FetchStrategy from what is specified for the given association attribute.

Parameters:

attributeDefinition - The association attribute definition.

fetchStrategy - The fetch strategy for attributeDefinition.

Returns:

the FetchStrategy, possibly adjusted by this strategy.

isTooManyCollections

protected boolean isTooManyCollections()

Overrides:

isTooManyCollections in class AbstractLoadPlanBuildingAssociationVisitationStrategy