Top Description Fields Constructors Methods

org.hibernate.engine

public Class LoadQueryInfluencers

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.hibernate.engine.LoadQueryInfluencers

All Implemented Interfaces

java.io.Serializable

Imports

java.util.Map, .Set, .Iterator, .HashMap, .HashSet, java.io.Serializable, org.hibernate.Filter, .UnknownProfileException, org.hibernate.type.Type, org.hibernate.impl.FilterImpl

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

Field Summary

Modifier and Type	Field and Description
private Set<E>	enabledFetchProfileNames
private Map<K, V>	enabledFilters
private String	internalFetchProfile
public static LoadQueryInfluencers	NONE Static reference useful for cases where we are creating load SQL outside the context of any influencers.
private final SessionFactoryImplementor	sessionFactory

Constructor Summary

Access	Constructor and Description
public	LoadQueryInfluencers()
public	LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)
private	LoadQueryInfluencers(SessionFactoryImplementor sessionFactory, Map<K, V> enabledFilters, Set<E> enabledFetchProfileNames)

Method Summary

Modifier and Type	Method and Description
private void	checkFetchProfileName(String name)
public void	disableFetchProfile(String name)
public void	disableFilter(String filterName)
public void	enableFetchProfile(String name)
public Filter	enableFilter(String filterName)
public Set<E>	getEnabledFetchProfileNames()
public Filter	getEnabledFilter(String filterName)
public Set<E>	Returns: an unmodifiable Set of enabled filter names. getEnabledFilterNames() Returns an unmodifiable Set of enabled filter names.
public Map<K, V>	getEnabledFilters()
public Type	getFilterParameterType(String filterParameterName)
public Object	getFilterParameterValue(String filterParameterName)
public String	getInternalFetchProfile()
public SessionFactoryImplementor	getSessionFactory()
public boolean	hasEnabledFetchProfiles()
public boolean	hasEnabledFilters()
public boolean	isFetchProfileEnabled(String name)
public static String[]	parseFilterParameterName(String filterParameterName)
public void	setInternalFetchProfile(String internalFetchProfile)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

enabledFetchProfileNames	back to summary
private Set<E> enabledFetchProfileNames

enabledFilters	back to summary
private Map<K, V> enabledFilters

internalFetchProfile	back to summary
private String internalFetchProfile

NONE	back to summary
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.

sessionFactory	back to summary
private final SessionFactoryImplementor sessionFactory

Constructor Detail

LoadQueryInfluencers	back to summary
public LoadQueryInfluencers()

LoadQueryInfluencers	back to summary
public LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)

LoadQueryInfluencers	back to summary
private LoadQueryInfluencers(SessionFactoryImplementor sessionFactory, Map<K, V> enabledFilters, Set<E> enabledFetchProfileNames)

Method Detail

checkFetchProfileName	back to summary
private void checkFetchProfileName(String name)

disableFetchProfile	back to summary
public void disableFetchProfile(String name) throws UnknownProfileException

disableFilter	back to summary
public void disableFilter(String filterName)

enableFetchProfile	back to summary
public void enableFetchProfile(String name) throws UnknownProfileException

enableFilter	back to summary
public Filter enableFilter(String filterName)

getEnabledFetchProfileNames	back to summary
public Set<E> getEnabledFetchProfileNames()

getEnabledFilter	back to summary
public Filter getEnabledFilter(String filterName)

getEnabledFilterNames

back to summary

public Set<E> getEnabledFilterNames()

Returns an unmodifiable Set of enabled filter names.

Returns:Set<E>: an unmodifiable Set of enabled filter names.

getEnabledFilters	back to summary
public Map<K, V> getEnabledFilters()

getFilterParameterType	back to summary
public Type getFilterParameterType(String filterParameterName)

getFilterParameterValue	back to summary
public Object getFilterParameterValue(String filterParameterName)

getInternalFetchProfile	back to summary
public String getInternalFetchProfile()

getSessionFactory	back to summary
public SessionFactoryImplementor getSessionFactory()

hasEnabledFetchProfiles	back to summary
public boolean hasEnabledFetchProfiles()

hasEnabledFilters	back to summary
public boolean hasEnabledFilters()

isFetchProfileEnabled	back to summary
public boolean isFetchProfileEnabled(String name) throws UnknownProfileException

parseFilterParameterName	back to summary
public static String[] parseFilterParameterName(String filterParameterName)

setInternalFetchProfile	back to summary
public void setInternalFetchProfile(String internalFetchProfile)