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 and 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 and Description
LoadQueryInfluencers()
LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)
LoadQueryInfluencers(SessionFactoryImplementor sessionFactory, Boolean readOnly)

Method Summary

Modifier and Type	Method and Description
void	disableFetchProfile(String name)
void	disableFilter(String filterName)
void	enableFetchProfile(String name)
Filter	enableFilter(String filterName)
EffectiveEntityGraph	getEffectiveEntityGraph()
Set<String>	getEnabledFetchProfileNames()
Filter	getEnabledFilter(String filterName)
Set<String>	getEnabledFilterNames() Returns an unmodifiable Set of enabled filter names.
Map<String,Filter>	getEnabledFilters()
EntityGraph	getFetchGraph() Deprecated. (since 5.4) getFetchGraph(), getLoadGraph(), setFetchGraph(javax.persistence.EntityGraph) and setLoadGraph(javax.persistence.EntityGraph) (as well as JPA itself honestly) all make it very unclear that there can be only one graph applied at any one time and that graph is *either* a load or a fetch graph. These have all been replaced with getEffectiveEntityGraph().
Type	getFilterParameterType(String filterParameterName)
Object	getFilterParameterValue(String filterParameterName)
String	getInternalFetchProfile()
EntityGraph	getLoadGraph() Deprecated. (since 5.4) getFetchGraph(), getLoadGraph(), setFetchGraph(javax.persistence.EntityGraph) and setLoadGraph(javax.persistence.EntityGraph) (as well as JPA itself honestly) all make it very unclear that there can be only one graph applied at any one time and that graph is *either* a load or a fetch graph. These have all been replaced with getEffectiveEntityGraph().
Boolean	getReadOnly()
SessionFactoryImplementor	getSessionFactory()
boolean	hasEnabledFetchProfiles()
boolean	hasEnabledFilters()
boolean	isFetchProfileEnabled(String name)
static String[]	parseFilterParameterName(String filterParameterName)
void	setFetchGraph(EntityGraph fetchGraph) Deprecated. (since 5.4) getFetchGraph(), getLoadGraph(), setFetchGraph(javax.persistence.EntityGraph) and setLoadGraph(javax.persistence.EntityGraph) (as well as JPA itself honestly) all make it very unclear that there can be only one graph applied at any one time and that graph is *either* a load or a fetch graph. These have all been replaced with getEffectiveEntityGraph().
void	setInternalFetchProfile(String internalFetchProfile)
void	setLoadGraph(EntityGraph loadGraph) Deprecated. (since 5.4) getFetchGraph(), getLoadGraph(), setFetchGraph(javax.persistence.EntityGraph) and setLoadGraph(javax.persistence.EntityGraph) (as well as JPA itself honestly) all make it very unclear that there can be only one graph applied at any one time and that that graph is *either* a load or a fetch graph. These have all been replaced with getEffectiveEntityGraph().
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()

getInternalFetchProfile

public String getInternalFetchProfile()

setInternalFetchProfile

public void setInternalFetchProfile(String internalFetchProfile)

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)

getFilterParameterType

public Type getFilterParameterType(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()

getFetchGraph

@Deprecated
public EntityGraph getFetchGraph()

Deprecated. (since 5.4) getFetchGraph(), getLoadGraph(), setFetchGraph(javax.persistence.EntityGraph) and setLoadGraph(javax.persistence.EntityGraph) (as well as JPA itself honestly) all make it very unclear that there can be only one graph applied at any one time and that graph is *either* a load or a fetch graph. These have all been replaced with getEffectiveEntityGraph().

See Also:

EffectiveEntityGraph

setFetchGraph

@Deprecated
public void setFetchGraph(EntityGraph fetchGraph)

Deprecated. (since 5.4) getFetchGraph(), getLoadGraph(), setFetchGraph(javax.persistence.EntityGraph) and setLoadGraph(javax.persistence.EntityGraph) (as well as JPA itself honestly) all make it very unclear that there can be only one graph applied at any one time and that graph is *either* a load or a fetch graph. These have all been replaced with getEffectiveEntityGraph().

See Also:

EffectiveEntityGraph

getLoadGraph

@Deprecated
public EntityGraph getLoadGraph()

Deprecated. (since 5.4) getFetchGraph(), getLoadGraph(), setFetchGraph(javax.persistence.EntityGraph) and setLoadGraph(javax.persistence.EntityGraph) (as well as JPA itself honestly) all make it very unclear that there can be only one graph applied at any one time and that graph is *either* a load or a fetch graph. These have all been replaced with getEffectiveEntityGraph().

See Also:

EffectiveEntityGraph

setLoadGraph

@Deprecated
public void setLoadGraph(EntityGraph loadGraph)

Deprecated. (since 5.4) getFetchGraph(), getLoadGraph(), setFetchGraph(javax.persistence.EntityGraph) and setLoadGraph(javax.persistence.EntityGraph) (as well as JPA itself honestly) all make it very unclear that there can be only one graph applied at any one time and that that graph is *either* a load or a fetch graph. These have all been replaced with getEffectiveEntityGraph().

See Also:

EffectiveEntityGraph

getReadOnly

public Boolean getReadOnly()

setReadOnly

public void setReadOnly(Boolean readOnly)