org.hibernate.engine

Class LoadQueryInfluencers

java.lang.Object

org.hibernate.engine.LoadQueryInfluencers

All Implemented Interfaces:

java.io.Serializable

public class LoadQueryInfluencers
extends java.lang.Object
implements java.io.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)

Author:

Steve Ebersole

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)

Method Summary

Methods

Modifier and Type	Method and Description
void	disableFetchProfile(java.lang.String name)
void	disableFilter(java.lang.String filterName)
void	enableFetchProfile(java.lang.String name)
Filter	enableFilter(java.lang.String filterName)
java.util.Set	getEnabledFetchProfileNames()
Filter	getEnabledFilter(java.lang.String filterName)
java.util.Set	getEnabledFilterNames() Returns an unmodifiable Set of enabled filter names.
java.util.Map	getEnabledFilters()
Type	getFilterParameterType(java.lang.String filterParameterName)
java.lang.Object	getFilterParameterValue(java.lang.String filterParameterName)
java.lang.String	getInternalFetchProfile()
SessionFactoryImplementor	getSessionFactory()
boolean	hasEnabledFetchProfiles()
boolean	hasEnabledFilters()
boolean	isFetchProfileEnabled(java.lang.String name)
static java.lang.String[]	parseFilterParameterName(java.lang.String filterParameterName)
void	setInternalFetchProfile(java.lang.String internalFetchProfile)

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static 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)

Method Detail

getSessionFactory

public SessionFactoryImplementor getSessionFactory()

getInternalFetchProfile

public java.lang.String getInternalFetchProfile()

setInternalFetchProfile

public void setInternalFetchProfile(java.lang.String internalFetchProfile)

hasEnabledFilters

public boolean hasEnabledFilters()

getEnabledFilters

public java.util.Map getEnabledFilters()

getEnabledFilterNames

public java.util.Set getEnabledFilterNames()

Returns an unmodifiable Set of enabled filter names.

Returns:

an unmodifiable Set of enabled filter names.

getEnabledFilter

public Filter getEnabledFilter(java.lang.String filterName)

enableFilter

public Filter enableFilter(java.lang.String filterName)

disableFilter

public void disableFilter(java.lang.String filterName)

getFilterParameterValue

public java.lang.Object getFilterParameterValue(java.lang.String filterParameterName)

getFilterParameterType

public Type getFilterParameterType(java.lang.String filterParameterName)

parseFilterParameterName

public static java.lang.String[] parseFilterParameterName(java.lang.String filterParameterName)

hasEnabledFetchProfiles

public boolean hasEnabledFetchProfiles()

getEnabledFetchProfileNames

public java.util.Set getEnabledFetchProfileNames()

isFetchProfileEnabled

public boolean isFetchProfileEnabled(java.lang.String name)
                              throws UnknownProfileException

Throws:

UnknownProfileException

enableFetchProfile

public void enableFetchProfile(java.lang.String name)
                        throws UnknownProfileException

Throws:

UnknownProfileException

disableFetchProfile

public void disableFetchProfile(java.lang.String name)
                         throws UnknownProfileException

Throws:

UnknownProfileException