org.hibernate.loader.spi

Interface LoadPlanAdvisor

All Known Implementing Classes:

EntityGraphBasedLoadPlanAdvisor, NoOpLoadPlanAdvisor

public interface LoadPlanAdvisor

An advisor that can be made available to the ResultSetProcessor and ScrollableResultSetProcessor. The processors consult with the advisor, if one is provided, as a means to influence the load plan, meaning that the advisor might add fetches. A caveat is that any added fetches cannot be join fetches (they cannot alter the SQL); if a fetch is added as FetchTiming.IMMEDIATE, it must be a "subsequent form": FetchStyle.SELECT, FetchStyle.SUBSELECT, FetchStyle.BATCH.

Method Summary

Methods

Modifier and Type	Method and Description
LoadPlan	advise(LoadPlan loadPlan) Advise on the given LoadPlan, returning a new LoadPlan if any additions are needed.

Method Detail

advise

LoadPlan advise(LoadPlan loadPlan)

Advise on the given LoadPlan, returning a new LoadPlan if any additions are needed. It is the responsibility of the advisor to return the original load plan if no additions were needed

Parameters:

loadPlan - The load plan to advise on.

Returns:

The original or advised load plan.