org.hibernate.engine
Class LoadQueryInfluencers

java.lang.Object
  extended by org.hibernate.engine.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:

Author:
Steve Ebersole
See Also:
Serialized Form

Field Summary
static LoadQueryInfluencers NONE
          Static reference useful for cases where we are creating load SQL outside the context of any influencers.
 
Constructor Summary
LoadQueryInfluencers()
           
LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)
           
 
Method Summary
 void disableFetchProfile(String name)
           
 void disableFilter(String filterName)
           
 void enableFetchProfile(String name)
           
 Filter enableFilter(String filterName)
           
 Set getEnabledFetchProfileNames()
           
 Filter getEnabledFilter(String filterName)
           
 Set getEnabledFilterNames()
          Returns an unmodifiable Set of enabled filter names.
 Map getEnabledFilters()
           
 Type getFilterParameterType(String filterParameterName)
           
 Object getFilterParameterValue(String filterParameterName)
           
 String getInternalFetchProfile()
           
 SessionFactoryImplementor getSessionFactory()
           
 boolean hasEnabledFetchProfiles()
           
 boolean hasEnabledFilters()
           
 boolean isFetchProfileEnabled(String name)
           
static String[] parseFilterParameterName(String filterParameterName)
           
 void setInternalFetchProfile(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 String getInternalFetchProfile()

setInternalFetchProfile

public void setInternalFetchProfile(String internalFetchProfile)

hasEnabledFilters

public boolean hasEnabledFilters()

getEnabledFilters

public Map getEnabledFilters()

getEnabledFilterNames

public Set 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 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


Copyright © 2001-2010 Red Hat, Inc. All Rights Reserved.