Package org.hibernate.engine.spi

Class LoadQueryInfluencers

java.lang.Object

org.hibernate.engine.spi.LoadQueryInfluencers

All Implemented Interfaces:

Serializable

public class LoadQueryInfluencers
extends Object
implements Serializable

Centralize all options which can influence the SQL query needed to load an entity. Currently, such influencers are defined as:

• filters
• fetch profiles
• internal fetch profile (merge profile, etc)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static LoadQueryInfluencers	NONE	Static reference useful for cases where we are creating load SQL outside the context of any influencers.

Constructor Summary

Constructors

Constructor	Description
LoadQueryInfluencers()
LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)
LoadQueryInfluencers(SessionFactoryImplementor sessionFactory, Boolean readOnly)

Method Summary

Modifier and Type	Method	Description
void	disableFetchProfile(String name)
void	disableFilter(String filterName)
void	enableFetchProfile(String name)
Filter	enableFilter(String filterName)
<T> T	fromInternalFetchProfile(CascadingFetchProfile profile, Supplier<T> supplier)
EffectiveEntityGraph	getEffectiveEntityGraph()
CascadingFetchProfile	getEnabledCascadingFetchProfile()	Fetch-profile to apply, if one, when building the result-graph for cascade fetching - for example, the result-graph used when handling a merge to immediately load additional based on CascadeType.MERGE
Set<String>	getEnabledFetchProfileNames()
Filter	getEnabledFilter(String filterName)
Set<String>	getEnabledFilterNames()	Returns an unmodifiable Set of enabled filter names.
Map<String,Filter>	getEnabledFilters()
Object	getFilterParameterValue(String filterParameterName)
String	getInternalFetchProfile()	Deprecated. Use getEnabledCascadingFetchProfile() instead
Boolean	getReadOnly()
SessionFactoryImplementor	getSessionFactory()
boolean	hasEnabledFetchProfiles()
boolean	hasEnabledFilters()
boolean	isFetchProfileEnabled(String name)
static String[]	parseFilterParameterName(String filterParameterName)
void	setEnabledCascadingFetchProfile(CascadingFetchProfile enabledCascadingFetchProfile)	Set the effective cascading fetch-profile
void	setInternalFetchProfile(String internalFetchProfile)	Deprecated. Use setEnabledCascadingFetchProfile(org.hibernate.loader.ast.spi.CascadingFetchProfile) instead
void	setReadOnly(Boolean readOnly)

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final LoadQueryInfluencers NONE

Static reference useful for cases where we are creating load SQL outside the context of any influencers. One such example is anything created by the session factory.

Constructor Detail

LoadQueryInfluencers

public LoadQueryInfluencers()

LoadQueryInfluencers

public LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)

LoadQueryInfluencers

public LoadQueryInfluencers(SessionFactoryImplementor sessionFactory,
                            Boolean readOnly)

Method Detail

getSessionFactory

public SessionFactoryImplementor getSessionFactory()

fromInternalFetchProfile

public <T> T fromInternalFetchProfile(CascadingFetchProfile profile,
                                      Supplier<T> supplier)

getEnabledCascadingFetchProfile

public CascadingFetchProfile getEnabledCascadingFetchProfile()

Fetch-profile to apply, if one, when building the result-graph for cascade fetching - for example, the result-graph used when handling a merge to immediately load additional based on CascadeType.MERGE

setEnabledCascadingFetchProfile

public void setEnabledCascadingFetchProfile(CascadingFetchProfile enabledCascadingFetchProfile)

Set the effective cascading fetch-profile

getInternalFetchProfile

@Deprecated(since="6.0")
public String getInternalFetchProfile()

Deprecated.

Use getEnabledCascadingFetchProfile() instead

setInternalFetchProfile

@Deprecated(since="6.0")
public void setInternalFetchProfile(String internalFetchProfile)

Deprecated.

Use setEnabledCascadingFetchProfile(org.hibernate.loader.ast.spi.CascadingFetchProfile) instead

hasEnabledFilters

public boolean hasEnabledFilters()

getEnabledFilters

public Map<String,Filter> getEnabledFilters()

getEnabledFilterNames

public Set<String> getEnabledFilterNames()

Returns an unmodifiable Set of enabled filter names.

Returns:

an unmodifiable Set of enabled filter names.

getEnabledFilter

public Filter getEnabledFilter(String filterName)

enableFilter

public Filter enableFilter(String filterName)

disableFilter

public void disableFilter(String filterName)

getFilterParameterValue

public Object getFilterParameterValue(String filterParameterName)

parseFilterParameterName

public static String[] parseFilterParameterName(String filterParameterName)

hasEnabledFetchProfiles

public boolean hasEnabledFetchProfiles()

getEnabledFetchProfileNames

public Set<String> getEnabledFetchProfileNames()

isFetchProfileEnabled

public boolean isFetchProfileEnabled(String name)
                              throws UnknownProfileException

Throws:

UnknownProfileException

enableFetchProfile

public void enableFetchProfile(String name)
                        throws UnknownProfileException

Throws:

UnknownProfileException

disableFetchProfile

public void disableFetchProfile(String name)
                         throws UnknownProfileException

Throws:

UnknownProfileException

getEffectiveEntityGraph

public EffectiveEntityGraph getEffectiveEntityGraph()

getReadOnly

public Boolean getReadOnly()

setReadOnly

public void setReadOnly(Boolean readOnly)