Describes a plan for performing a load of results. Generally speaking there are 3 forms of load plans:

org.hibernate.loader.plan.spi.LoadPlan.Disposition#ENTITY_LOADER - An entity load plan for handling get/load handling. This form will typically have a single return (of type org.hibernate.loader.plan.spi.EntityReturn) defined by getReturns(), possibly defining fetches.
org.hibernate.loader.plan.spi.LoadPlan.Disposition#COLLECTION_INITIALIZER - A collection initializer, used to load the contents of a collection. This form will typically have a single return (of type org.hibernate.loader.plan.spi.CollectionReturn) defined by getReturns(), possibly defining fetches
org.hibernate.loader.plan.spi.LoadPlan.Disposition#MIXED - A query load plan which can contain multiple returns of mixed type (though all implementing org.hibernate.loader.plan.spi.Return). Again, may possibly define fetches.

todo : would also like to see "call back" style access for handling "subsequent actions" such as...

follow-on locking
join fetch conversions to subselect fetches

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	LoadPlan.Disposition Enumerated possibilities for describing the disposition of this LoadPlan.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: Whether or not to areLazyAttributesForceFetched() Does this load plan indicate that lazy attributes are to be force fetched?
public LoadPlan.Disposition	Returns: The LoadPlan's disposition getDisposition() What is the disposition of this LoadPlan, in terms of its returns.
public QuerySpaces	Returns: The 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`.
public List<? extends Return>	Returns: The Returns for this LoadPlan. getReturns() Get the returns indicated by this LoadPlan.
public boolean	Returns: `true` if `getReturns()` contained any scalar returns; `false` otherwise. hasAnyScalarReturns() Convenient form of checking `getReturns()` for scalar root returns.

Method Detail

areLazyAttributesForceFetched back to summary

areLazyAttributesForceFetched	back to summary
public 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. 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. Returns:boolean Whether or not to

public 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. 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.

Returns:boolean: Whether or not to

getDisposition	back to summary
public LoadPlan.Disposition getDisposition() What is the disposition of this LoadPlan, in terms of its returns. Returns:LoadPlan.Disposition The LoadPlan's disposition

getDisposition

back to summary

public LoadPlan.Disposition getDisposition()

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

Returns:LoadPlan.Disposition: The LoadPlan's disposition

getQuerySpaces back to summary

getQuerySpaces	back to summary
public 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`. When generating SQL, the query spaces provide data for the "from clause" including joins. Returns:QuerySpaces The QuerySpaces

public 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.

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

Returns:QuerySpaces: The QuerySpaces

getReturns back to summary

getReturns	back to summary
public List<? extends Return> getReturns() Get the returns indicated by this LoadPlan. A `Disposition#ENTITY_LOADER` LoadPlan would have just a single Return of type `org.hibernate.loader.plan.spi.EntityReturn`. A `Disposition#COLLECTION_INITIALIZER` LoadPlan would have just a single Return of type `org.hibernate.loader.plan.spi.CollectionReturn`. A `Disposition#MIXED` LoadPlan would contain a mix of `org.hibernate.loader.plan.spi.EntityReturn` and `org.hibernate.loader.plan.spi.ScalarReturn` elements, but no `org.hibernate.loader.plan.spi.CollectionReturn`. When generating SQL, the Returns provide columns/formulas used in the "select clause". Returns:List<? extends Return> The Returns for this LoadPlan. See Also `Disposition`

public List<? extends Return> getReturns()

Get the returns indicated by this LoadPlan.

A Disposition#ENTITY_LOADER LoadPlan would have just a single Return of type org.hibernate.loader.plan.spi.EntityReturn.
A Disposition#COLLECTION_INITIALIZER LoadPlan would have just a single Return of type org.hibernate.loader.plan.spi.CollectionReturn.
A Disposition#MIXED LoadPlan would contain a mix of org.hibernate.loader.plan.spi.EntityReturn and org.hibernate.loader.plan.spi.ScalarReturn elements, but no org.hibernate.loader.plan.spi.CollectionReturn.

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

Returns:List<? extends Return>: The Returns for this LoadPlan.
See Also: Disposition

hasAnyScalarReturns back to summary

hasAnyScalarReturns	back to summary
public boolean hasAnyScalarReturns() Convenient form of checking `getReturns()` for scalar root returns. Returns:boolean `true` if `getReturns()` contained any scalar returns; `false` otherwise.

public boolean hasAnyScalarReturns()

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

Returns:boolean: true if getReturns() contained any scalar returns; false otherwise.

org.hibernate.loader.plan.spi back to summary

public final Enum LoadPlan.Disposition

Class Inheritance

extends Enum<LoadPlan.Disposition>

java.lang.Object
java.lang.Enum
org.hibernate.loader.plan.spi.LoadPlan.Disposition

Enumerated possibilities for describing the disposition of this LoadPlan.

Field Summary

Modifier and Type	Field and Description
public static final LoadPlan.Disposition	COLLECTION_INITIALIZER This is a "collection initializer" load plan, which describes a plan for loading one or more entity instances of the same collection type.
public static final LoadPlan.Disposition	ENTITY_LOADER This is an "entity loader" load plan, which describes a plan for loading one or more entity instances of the same entity type.
public static final LoadPlan.Disposition	MIXED We have a mixed load plan, which will have one or more returns of `org.hibernate.loader.plan.spi.EntityReturn` and `org.hibernate.loader.plan.spi.ScalarReturn` (NOT `org.hibernate.loader.plan.spi.CollectionReturn`).

Constructor Summary

Access	Constructor and Description
private	Disposition()

Method Summary

Modifier and Type	Method and Description
public static LoadPlan.Disposition	valueOf(String name)
public static LoadPlan.Disposition[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COLLECTION_INITIALIZER	back to summary
public static final LoadPlan.Disposition COLLECTION_INITIALIZER This is a "collection initializer" load plan, which describes a plan for loading one or more entity instances of the same collection type. There is a single return, which will be of type `org.hibernate.loader.plan.spi.CollectionReturn`

ENTITY_LOADER	back to summary
public static final LoadPlan.Disposition ENTITY_LOADER This is an "entity loader" load plan, which describes a plan for loading one or more entity instances of the same entity type. There is a single return, which will be of type `org.hibernate.loader.plan.spi.EntityReturn`

MIXED	back to summary
public static final LoadPlan.Disposition MIXED We have a mixed load plan, which will have one or more returns of `org.hibernate.loader.plan.spi.EntityReturn` and `org.hibernate.loader.plan.spi.ScalarReturn` (NOT `org.hibernate.loader.plan.spi.CollectionReturn`).

Constructor Detail

Disposition	back to summary
private Disposition()

Method Detail

valueOf	back to summary
public static LoadPlan.Disposition valueOf(String name)

values	back to summary
public static LoadPlan.Disposition[] values()

public Interface LoadPlan

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum LoadPlan.Disposition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail