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

Constructor Summary

Constructors

Constructor	Description
LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)
LoadQueryInfluencers(SessionFactoryImplementor sessionFactory, SessionCreationOptions options)

Method Summary

Modifier and Type	Method	Description
@Nullable HashSet<String>	adjustFetchProfiles(@Nullable Set<String> disabledFetchProfiles, @Nullable Set<String> enabledFetchProfiles)
EffectiveEntityGraph	applyEntityGraph(@Nullable RootGraphImplementor<?> rootGraph, @Nullable GraphSemantic graphSemantic)
void	disableFetchProfile(String name)
void	disableFilter(String filterName)
int	effectiveBatchSize(CollectionPersister persister)
int	effectiveBatchSize(EntityPersister persister)
boolean	effectivelyBatchLoadable(CollectionPersister persister)
boolean	effectivelyBatchLoadable(EntityPersister persister)
boolean	effectiveSubselectFetchEnabled(CollectionPersister persister)
void	enableFetchProfile(String name)
Filter	enableFilter(String filterName)
<T> T	fromInternalFetchProfile(CascadingFetchProfile profile, Supplier<T> supplier)
int	getBatchSize()
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()
@Nullable 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	getSubselectFetchEnabled()
boolean	hasEnabledCascadingFetchProfile()
boolean	hasEnabledFetchProfiles()
boolean	hasEnabledFilters()
boolean	hasSubselectLoadableCollections(EntityPersister persister)
boolean	isFetchProfileEnabled(String name)
static String[]	parseFilterParameterName(String filterParameterName)
void	setBatchSize(int batchSize)
void	setEnabledCascadingFetchProfile(CascadingFetchProfile enabledCascadingFetchProfile)	Set the effective cascading fetch-profile
void	setEnabledFetchProfileNames(HashSet<String> enabledFetchProfileNames)
void	setInternalFetchProfile(String internalFetchProfile)	Deprecated. Use setEnabledCascadingFetchProfile(org.hibernate.loader.ast.spi.CascadingFetchProfile) instead
void	setReadOnly(Boolean readOnly)
void	setSubselectFetchEnabled(boolean subselectFetchEnabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadQueryInfluencers

public LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)

LoadQueryInfluencers

public LoadQueryInfluencers(SessionFactoryImplementor sessionFactory,
                            SessionCreationOptions options)

Method Detail

applyEntityGraph

public EffectiveEntityGraph applyEntityGraph(@Nullable RootGraphImplementor<?> rootGraph,
                                             @Nullable GraphSemantic graphSemantic)

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

hasEnabledCascadingFetchProfile

public boolean hasEnabledCascadingFetchProfile()

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 @Nullable 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

adjustFetchProfiles

@Internal
public @Nullable HashSet<String> adjustFetchProfiles(@Nullable Set<String> disabledFetchProfiles,
                                                     @Nullable Set<String> enabledFetchProfiles)

setEnabledFetchProfileNames

@Internal
public void setEnabledFetchProfileNames(HashSet<String> enabledFetchProfileNames)

getEffectiveEntityGraph

public EffectiveEntityGraph getEffectiveEntityGraph()

getReadOnly

public Boolean getReadOnly()

setReadOnly

public void setReadOnly(Boolean readOnly)

getBatchSize

public int getBatchSize()

setBatchSize

public void setBatchSize(int batchSize)

effectiveBatchSize

public int effectiveBatchSize(CollectionPersister persister)

effectivelyBatchLoadable

public boolean effectivelyBatchLoadable(CollectionPersister persister)

effectiveBatchSize

public int effectiveBatchSize(EntityPersister persister)

effectivelyBatchLoadable

public boolean effectivelyBatchLoadable(EntityPersister persister)

getSubselectFetchEnabled

public boolean getSubselectFetchEnabled()

setSubselectFetchEnabled

public void setSubselectFetchEnabled(boolean subselectFetchEnabled)

effectiveSubselectFetchEnabled

public boolean effectiveSubselectFetchEnabled(CollectionPersister persister)

hasSubselectLoadableCollections

public boolean hasSubselectLoadableCollections(EntityPersister persister)