org.hibernate.loader.plan.build.internal

Class LoadPlanImpl

java.lang.Object

org.hibernate.loader.plan.build.internal.LoadPlanImpl

All Implemented Interfaces:

LoadPlan

public class LoadPlanImpl
extends java.lang.Object
implements LoadPlan

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.loader.plan.spi.LoadPlan

LoadPlan.Disposition

Constructor Summary

Constructors

Modifier	Constructor and Description
	LoadPlanImpl(CollectionReturn rootReturn, QuerySpaces querySpaces) Creates a Disposition#COLLECTION_INITIALIZER LoadPlan.
	LoadPlanImpl(EntityReturn rootReturn, QuerySpaces querySpaces) Creates a Disposition#ENTITY_LOADER LoadPlan.
	LoadPlanImpl(java.util.List<? extends Return> returns, QuerySpaces querySpaces, boolean areLazyAttributesForceFetched) Creates a Disposition#MIXED LoadPlan.
protected	LoadPlanImpl(java.util.List<? extends Return> returns, QuerySpaces querySpaces, LoadPlan.Disposition disposition, boolean areLazyAttributesForceFetched)

Method Summary

Modifier and Type	Method and Description
boolean	areLazyAttributesForceFetched() Does this load plan indicate that lazy attributes are to be force fetched? Here we are talking about laziness in regards to the legacy bytecode enhancement which adds support for partial selects of an entity's state (e.g., skip loading a lob initially, wait until/if it is needed) This one would effect the SQL that needs to get generated as well as how the result set would be read.
LoadPlan.Disposition	getDisposition() What is the disposition of this LoadPlan, in terms of its returns.
QuerySpaces	getQuerySpaces() Gets the QuerySpaces for the load plan, which contains a QuerySpace reference for each non-scalar return and for each entity, collection, and composite FetchSource.
java.util.List<? extends Return>	getReturns() Get the returns indicated by this LoadPlan. A LoadPlan.Disposition.ENTITY_LOADER LoadPlan would have just a single Return of type EntityReturn.
boolean	hasAnyScalarReturns() Convenient form of checking LoadPlan.getReturns() for scalar root returns.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadPlanImpl

protected LoadPlanImpl(java.util.List<? extends Return> returns,
                       QuerySpaces querySpaces,
                       LoadPlan.Disposition disposition,
                       boolean areLazyAttributesForceFetched)

LoadPlanImpl

public LoadPlanImpl(EntityReturn rootReturn,
                    QuerySpaces querySpaces)

Creates a Disposition#ENTITY_LOADER LoadPlan.

Parameters:

rootReturn - The EntityReturn representation of the entity being loaded.

querySpaces - The QuerySpaces containing all the query space references required for rootReturn and joined entity, collection, and composite references.

LoadPlanImpl

public LoadPlanImpl(CollectionReturn rootReturn,
                    QuerySpaces querySpaces)

Creates a Disposition#COLLECTION_INITIALIZER LoadPlan.

Parameters:

rootReturn - The CollectionReturn representation of the collection being initialized.

querySpaces - The QuerySpaces containing all the query space references required for rootReturn and joined entity, collection, and composite references.

LoadPlanImpl

public LoadPlanImpl(java.util.List<? extends Return> returns,
                    QuerySpaces querySpaces,
                    boolean areLazyAttributesForceFetched)

Creates a Disposition#MIXED LoadPlan.

Parameters:

returns - The mixed Return references

querySpaces - The QuerySpaces containing all the query space references required for rootReturn and joined entity, collection, and composite references.

areLazyAttributesForceFetched - Should lazy attributes (bytecode enhanced laziness) be fetched also? This effects the eventual SQL SELECT-clause which is why we have it here. Currently this is "all-or-none"; you can request that all lazy properties across all entities in the loadplan be force fetched or none. There is no entity-by-entity option. FETCH ALL PROPERTIES is the way this is requested in HQL. Would be nice to consider this entity-by-entity, as opposed to all-or-none. For example, "fetch the LOB value for the Item.image attribute, but no others (leave them lazy)". Not too concerned about having it at the attribute level.

Method Detail

getReturns

public java.util.List<? extends Return> getReturns()

Description copied from interface: LoadPlan

Get the returns indicated by this LoadPlan.

• A LoadPlan.Disposition.ENTITY_LOADER LoadPlan would have just a single Return of type EntityReturn.
• A LoadPlan.Disposition.COLLECTION_INITIALIZER LoadPlan would have just a single Return of type CollectionReturn.
• A LoadPlan.Disposition.MIXED LoadPlan would contain a mix of EntityReturn and ScalarReturn elements, but no CollectionReturn.

When generating SQL, the Returns provide columns/formulas used in the "select clause".

Specified by:

getReturns in interface LoadPlan

Returns:

The Returns for this LoadPlan.

See Also:

LoadPlan.Disposition

getQuerySpaces

public QuerySpaces getQuerySpaces()

Description copied from interface: LoadPlan

Gets the QuerySpaces for the load plan, which contains a QuerySpace reference for each non-scalar return and for each entity, collection, and composite FetchSource.

When generating SQL, the query spaces provide data for the "from clause" including joins.

Specified by:

getQuerySpaces in interface LoadPlan

Returns:

The QuerySpaces

getDisposition

public LoadPlan.Disposition getDisposition()

Description copied from interface: LoadPlan

What is the disposition of this LoadPlan, in terms of its returns.

Specified by:

getDisposition in interface LoadPlan

Returns:

The LoadPlan's disposition

areLazyAttributesForceFetched

public boolean areLazyAttributesForceFetched()

Description copied from interface: LoadPlan

Does this load plan indicate that lazy attributes are to be force fetched?

Here we are talking about laziness in regards to the legacy bytecode enhancement which adds support for partial selects of an entity's state (e.g., skip loading a lob initially, wait until/if it is needed)

This one would effect the SQL that needs to get generated as well as how the result set would be read. Therefore we make this part of the LoadPlan contract.

NOTE that currently this is only relevant for HQL loaders when the HQL has specified the FETCH ALL PROPERTIES key-phrase. In all other cases, this returns false.

Specified by:

areLazyAttributesForceFetched in interface LoadPlan

Returns:

Whether or not to

hasAnyScalarReturns

public boolean hasAnyScalarReturns()

Description copied from interface: LoadPlan

Convenient form of checking LoadPlan.getReturns() for scalar root returns.

Specified by:

hasAnyScalarReturns in interface LoadPlan

Returns:

true if LoadPlan.getReturns() contained any scalar returns; false otherwise.