org.hibernate.loader.plan.build.internal

Class AbstractLoadPlanBuildingAssociationVisitationStrategy

java.lang.Object

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

All Implemented Interfaces:

LoadPlanBuildingAssociationVisitationStrategy, LoadPlanBuildingContext, AssociationVisitationStrategy

Direct Known Subclasses:

AbstractEntityGraphVisitationStrategy, FetchStyleLoadPlanBuildingAssociationVisitationStrategy

public abstract class AbstractLoadPlanBuildingAssociationVisitationStrategy
extends Object
implements LoadPlanBuildingAssociationVisitationStrategy, LoadPlanBuildingContext

A LoadPlanBuildingAssociationVisitationStrategy is a strategy for building a LoadPlan. LoadPlanBuildingAssociationVisitationStrategy is also a AssociationVisitationStrategy, which is used in conjunction with visiting associations via walking metamodel definitions.

So this strategy defines a AssociationVisitationStrategy that walks the metamodel-defined associations after which is can then build a LoadPlan based on the visited associations. determineFetchStrategy(org.hibernate.persister.walking.spi.AssociationAttributeDefinition) is the main decision point that determines if an association is walked.

Author:

Steve Ebersole

See Also:

LoadPlanBuildingAssociationVisitationStrategy, AssociationVisitationStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractLoadPlanBuildingAssociationVisitationStrategy.PropertyPathStack Maintains stack information for the property paths we are processing for logging purposes.

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyPath	currentPropertyPath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLoadPlanBuildingAssociationVisitationStrategy(SessionFactoryImplementor sessionFactory) Constructs an AbstractLoadPlanBuildingAssociationVisitationStrategy.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addRootReturn(Return rootReturn)
void	associationKeyRegistered(AssociationKey associationKey)
protected int	currentDepth()
protected ExpandingFetchSource	currentSource()
protected abstract FetchStrategy	determineFetchStrategy(AssociationAttributeDefinition attributeDefinition)
void	finish() Notification we are finished visitation.
void	finishingAttribute(AttributeDefinition attributeDefinition) Notification that we are finishing walking an attribute.
void	finishingCollection(CollectionDefinition collectionDefinition) Notification that we are finishing walking a collection
void	finishingCollectionElements(CollectionElementDefinition elementDefinition) Notification that we are finishing walking the elements of a collection (List/Map).
void	finishingCollectionIndex(CollectionIndexDefinition indexDefinition) Notification that we are finishing walking the index of a collection (List/Map).
void	finishingComposite(CompositionDefinition compositionDefinition) Notification that we are done walking a composite.
void	finishingEntity(EntityDefinition entityDefinition) Notification we are finishing walking an entity.
void	finishingEntityIdentifier(EntityIdentifierDefinition entityIdentifierDefinition) Notification we are finishing walking an entity.
void	foundAny(AnyMappingDefinition anyDefinition)
void	foundCircularAssociation(AssociationAttributeDefinition attributeDefinition)
ExpandingQuerySpaces	getQuerySpaces()
SessionFactoryImplementor	getSessionFactory() Access to the SessionFactory
protected boolean	handleAssociationAttribute(AssociationAttributeDefinition attributeDefinition)
protected boolean	handleCompositeAttribute(AttributeDefinition attributeDefinition)
boolean	isDuplicateAssociationKey(AssociationKey associationKey)
protected boolean	isTooManyCollections()
FetchSource	registeredFetchSource(AssociationKey associationKey)
protected SessionFactoryImplementor	sessionFactory() Gets the session factory.
void	start() Notification we are preparing to start visitation.
boolean	startingAttribute(AttributeDefinition attributeDefinition) Notification that we are preparing to walk an attribute.
void	startingCollection(CollectionDefinition collectionDefinition) Notification that we are starting to walk a collection
void	startingCollectionElements(CollectionElementDefinition elementDefinition) Notification that we are starting to look at the element definition for the collection.
void	startingCollectionIndex(CollectionIndexDefinition indexDefinition) Notification that we are starting to walk the index of a collection (List/Map).
void	startingComposite(CompositionDefinition compositionDefinition) Notification that we are preparing to walk a composite.
void	startingEntity(EntityDefinition entityDefinition) Notification we are starting to walk an entity.
void	startingEntityIdentifier(EntityIdentifierDefinition entityIdentifierDefinition) Notification we are starting to walk the identifier of an entity.
protected boolean	supportsRootCollectionReturns()
protected boolean	supportsRootEntityReturns()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.loader.plan.build.spi.LoadPlanBuildingAssociationVisitationStrategy

buildLoadPlan

Field Detail

currentPropertyPath

protected PropertyPath currentPropertyPath

Constructor Detail

AbstractLoadPlanBuildingAssociationVisitationStrategy

protected AbstractLoadPlanBuildingAssociationVisitationStrategy(SessionFactoryImplementor sessionFactory)

Constructs an AbstractLoadPlanBuildingAssociationVisitationStrategy.

Parameters:

sessionFactory - The session factory.

Method Detail

sessionFactory

protected SessionFactoryImplementor sessionFactory()

Gets the session factory.

Returns:

The session factory.

getQuerySpaces

public ExpandingQuerySpaces getQuerySpaces()

Specified by:

getQuerySpaces in interface LoadPlanBuildingContext

currentSource

protected ExpandingFetchSource currentSource()

start

public void start()

Description copied from interface: AssociationVisitationStrategy

Notification we are preparing to start visitation.

Specified by:

start in interface AssociationVisitationStrategy

finish

public void finish()

Description copied from interface: AssociationVisitationStrategy

Notification we are finished visitation.

Specified by:

finish in interface AssociationVisitationStrategy

addRootReturn

protected abstract void addRootReturn(Return rootReturn)

supportsRootEntityReturns

protected boolean supportsRootEntityReturns()

startingEntity

public void startingEntity(EntityDefinition entityDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification we are starting to walk an entity.

Specified by:

startingEntity in interface AssociationVisitationStrategy

Parameters:

entityDefinition - The entity we are preparing to walk

finishingEntity

public void finishingEntity(EntityDefinition entityDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification we are finishing walking an entity.

Specified by:

finishingEntity in interface AssociationVisitationStrategy

Parameters:

entityDefinition - The entity we are finishing walking.

startingEntityIdentifier

public void startingEntityIdentifier(EntityIdentifierDefinition entityIdentifierDefinition)

Description copied from interface: AssociationVisitationStrategy

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

Specified by:

startingEntityIdentifier in interface AssociationVisitationStrategy

Parameters:

entityIdentifierDefinition - The identifier we are preparing to walk

finishingEntityIdentifier

public void finishingEntityIdentifier(EntityIdentifierDefinition entityIdentifierDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification we are finishing walking an entity.

Specified by:

finishingEntityIdentifier in interface AssociationVisitationStrategy

Parameters:

entityIdentifierDefinition - The identifier we are finishing walking.

startingCollection

public void startingCollection(CollectionDefinition collectionDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are starting to walk a collection

Specified by:

startingCollection in interface AssociationVisitationStrategy

Parameters:

collectionDefinition - The collection we are preparing to walk

supportsRootCollectionReturns

protected boolean supportsRootCollectionReturns()

finishingCollection

public void finishingCollection(CollectionDefinition collectionDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are finishing walking a collection

Specified by:

finishingCollection in interface AssociationVisitationStrategy

Parameters:

collectionDefinition - The collection we are finishing

startingCollectionIndex

public void startingCollectionIndex(CollectionIndexDefinition indexDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are starting to walk the index of a collection (List/Map). In the case of a Map, if the indices (the keys) are entities this will be followed up by a call to AssociationVisitationStrategy.startingEntity(org.hibernate.persister.walking.spi.EntityDefinition)

Specified by:

startingCollectionIndex in interface AssociationVisitationStrategy

Parameters:

indexDefinition - The collection index we are preparing to walk.

finishingCollectionIndex

public void finishingCollectionIndex(CollectionIndexDefinition indexDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are finishing walking the index of a collection (List/Map).

Specified by:

finishingCollectionIndex in interface AssociationVisitationStrategy

Parameters:

indexDefinition - The collection index we are finishing

startingCollectionElements

public void startingCollectionElements(CollectionElementDefinition elementDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are starting to look at the element definition for the collection. If the collection elements are entities this will be followed up by a call to AssociationVisitationStrategy.startingEntity(org.hibernate.persister.walking.spi.EntityDefinition)

Specified by:

startingCollectionElements in interface AssociationVisitationStrategy

Parameters:

elementDefinition - The collection element we are preparing to walk..

finishingCollectionElements

public void finishingCollectionElements(CollectionElementDefinition elementDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are finishing walking the elements of a collection (List/Map).

Specified by:

finishingCollectionElements in interface AssociationVisitationStrategy

Parameters:

elementDefinition - The collection element we are finishing

startingComposite

public void startingComposite(CompositionDefinition compositionDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are preparing to walk a composite. This is called only for:

• top-level composites for entity attributes. composite entity identifiers do not route through here, see AssociationVisitationStrategy.startingEntityIdentifier(org.hibernate.persister.walking.spi.EntityIdentifierDefinition) if you need to hook into walking the top-level cid composite.
• All forms of nested composite paths

Specified by:

startingComposite in interface AssociationVisitationStrategy

Parameters:

compositionDefinition - The composite we are preparing to walk.

finishingComposite

public void finishingComposite(CompositionDefinition compositionDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are done walking a composite. Called on the back-end of the situations listed on AssociationVisitationStrategy.startingComposite(org.hibernate.persister.walking.spi.CompositionDefinition)

Specified by:

finishingComposite in interface AssociationVisitationStrategy

Parameters:

compositionDefinition - The composite we are finishing

startingAttribute

public boolean startingAttribute(AttributeDefinition attributeDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are preparing to walk an attribute. May be followed by calls to AssociationVisitationStrategy.startingEntity(org.hibernate.persister.walking.spi.EntityDefinition) (one-to-one, many-to-one), AssociationVisitationStrategy.startingComposite(org.hibernate.persister.walking.spi.CompositionDefinition), or AssociationVisitationStrategy.startingCollection(org.hibernate.persister.walking.spi.CollectionDefinition).

Specified by:

startingAttribute in interface AssociationVisitationStrategy

Parameters:

attributeDefinition - The attribute we are preparing to walk.

Returns:

true if the walking should continue; false if walking should stop.

finishingAttribute

public void finishingAttribute(AttributeDefinition attributeDefinition)

Description copied from interface: AssociationVisitationStrategy

Notification that we are finishing walking an attribute.

Specified by:

finishingAttribute in interface AssociationVisitationStrategy

Parameters:

attributeDefinition - The attribute we are done walking

isDuplicateAssociationKey

public boolean isDuplicateAssociationKey(AssociationKey associationKey)

Specified by:

isDuplicateAssociationKey in interface AssociationVisitationStrategy

associationKeyRegistered

public void associationKeyRegistered(AssociationKey associationKey)

Specified by:

associationKeyRegistered in interface AssociationVisitationStrategy

registeredFetchSource

public FetchSource registeredFetchSource(AssociationKey associationKey)

Specified by:

registeredFetchSource in interface LoadPlanBuildingContext

Specified by:

registeredFetchSource in interface AssociationVisitationStrategy

foundCircularAssociation

public void foundCircularAssociation(AssociationAttributeDefinition attributeDefinition)

Specified by:

foundCircularAssociation in interface AssociationVisitationStrategy

foundAny

public void foundAny(AnyMappingDefinition anyDefinition)

Specified by:

foundAny in interface AssociationVisitationStrategy

handleCompositeAttribute

protected boolean handleCompositeAttribute(AttributeDefinition attributeDefinition)

handleAssociationAttribute

protected boolean handleAssociationAttribute(AssociationAttributeDefinition attributeDefinition)

determineFetchStrategy

protected abstract FetchStrategy determineFetchStrategy(AssociationAttributeDefinition attributeDefinition)

currentDepth

protected int currentDepth()

isTooManyCollections

protected boolean isTooManyCollections()

getSessionFactory

public SessionFactoryImplementor getSessionFactory()

Description copied from interface: LoadPlanBuildingContext

Access to the SessionFactory

Specified by:

getSessionFactory in interface LoadPlanBuildingContext

Returns:

The SessionFactory