org.hibernate.loader.plan.spi

Interface FetchOwner

All Known Subinterfaces:

FetchableCollectionElement, FetchableCollectionIndex

All Known Implementing Classes:

AbstractFetchOwner, AbstractLoadPlanBuilderStrategy.AbstractIdentifierAttributeCollector, AbstractLoadPlanBuilderStrategy.EncapsulatedIdentifierAttributeCollector, AbstractLoadPlanBuilderStrategy.NonEncapsulatedIdentifierAttributeCollector, AbstractSingularAttributeFetch, CompositeElementGraph, CompositeFetch, CompositeIndexGraph, EntityElementGraph, EntityFetch, EntityIndexGraph, EntityReturn, KeyManyToOneBidirectionalEntityFetch

public interface FetchOwner

Contract for owners of fetches. Any non-scalar return could be a fetch owner.

Field Summary

Fields

Modifier and Type	Field and Description
static Fetch[]	NO_FETCHES Convenient constant for returning no fetches from getFetches()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFetch(Fetch fetch) Contract to add fetches to this owner.
AnyFetch	buildAnyFetch(AttributeDefinition attribute, AnyMappingDefinition anyDefinition, FetchStrategy fetchStrategy, LoadPlanBuildingContext loadPlanBuildingContext)
CollectionFetch	buildCollectionFetch(AssociationAttributeDefinition attributeDefinition, FetchStrategy fetchStrategy, LoadPlanBuildingContext loadPlanBuildingContext)
CompositeFetch	buildCompositeFetch(CompositionDefinition attributeDefinition, LoadPlanBuildingContext loadPlanBuildingContext)
EntityFetch	buildEntityFetch(AssociationAttributeDefinition attributeDefinition, FetchStrategy fetchStrategy, LoadPlanBuildingContext loadPlanBuildingContext)
Fetch[]	getFetches() Retrieve the fetches owned by this return.
PropertyPath	getPropertyPath() Get the property path to this fetch owner
Type	getType(Fetch fetch) Returns the type of the specified fetch.
boolean	isNullable(Fetch fetch) Is the specified fetch nullable?
EntityPersister	retrieveFetchSourcePersister() Retrieve the EntityPersister that is the base for any property references in the fetches it owns.
SqlSelectFragmentResolver	toSqlSelectFragmentResolver()
String[]	toSqlSelectFragments(Fetch fetch, String alias) Generates the SQL select fragments for the specified fetch.
void	validateFetchPlan(FetchStrategy fetchStrategy, AttributeDefinition attributeDefinition) Is the asserted plan valid from this owner to a fetch?

Field Detail

NO_FETCHES

static final Fetch[] NO_FETCHES

Convenient constant for returning no fetches from getFetches()

Method Detail

addFetch

void addFetch(Fetch fetch)

Contract to add fetches to this owner. Care should be taken in calling this method; it is intended for Hibernate usage

Parameters:

fetch - The fetch to add

getFetches

Fetch[] getFetches()

Retrieve the fetches owned by this return.

Returns:

The owned fetches.

getType

Type getType(Fetch fetch)

Returns the type of the specified fetch.

Parameters:

fetch - - the owned fetch.

Returns:

the type of the specified fetch.

isNullable

boolean isNullable(Fetch fetch)

Is the specified fetch nullable?

Parameters:

fetch - - the owned fetch.

Returns:

true, if the fetch is nullable; false, otherwise.

toSqlSelectFragments

String[] toSqlSelectFragments(Fetch fetch,
                            String alias)

Generates the SQL select fragments for the specified fetch. A select fragment is the column and formula references.

Parameters:

fetch - - the owned fetch.

alias - The table alias to apply to the fragments (used to qualify column references)

Returns:

the select fragments

validateFetchPlan

void validateFetchPlan(FetchStrategy fetchStrategy,
                     AttributeDefinition attributeDefinition)

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

Parameters:

fetchStrategy - The type of fetch to validate

attributeDefinition - The attribute to be fetched

retrieveFetchSourcePersister

EntityPersister retrieveFetchSourcePersister()

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

Returns:

The EntityPersister, for property name resolution.

getPropertyPath

PropertyPath getPropertyPath()

Get the property path to this fetch owner

Returns:

The property path

buildCollectionFetch

CollectionFetch buildCollectionFetch(AssociationAttributeDefinition attributeDefinition,
                                   FetchStrategy fetchStrategy,
                                   LoadPlanBuildingContext loadPlanBuildingContext)

buildEntityFetch

EntityFetch buildEntityFetch(AssociationAttributeDefinition attributeDefinition,
                           FetchStrategy fetchStrategy,
                           LoadPlanBuildingContext loadPlanBuildingContext)

buildCompositeFetch

CompositeFetch buildCompositeFetch(CompositionDefinition attributeDefinition,
                                 LoadPlanBuildingContext loadPlanBuildingContext)

buildAnyFetch

AnyFetch buildAnyFetch(AttributeDefinition attribute,
                     AnyMappingDefinition anyDefinition,
                     FetchStrategy fetchStrategy,
                     LoadPlanBuildingContext loadPlanBuildingContext)

toSqlSelectFragmentResolver

SqlSelectFragmentResolver toSqlSelectFragmentResolver()