public class

LoadQueryInfluencers

extends Object
implements Serializable
java.lang.Object
   ↳ org.hibernate.engine.LoadQueryInfluencers

Class Overview

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)

Summary

Fields
public static LoadQueryInfluencers NONE Static reference useful for cases where we are creating load SQL outside the context of any influencers.
Public Constructors
LoadQueryInfluencers()
LoadQueryInfluencers(SessionFactoryImplementor sessionFactory)
Public Methods
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)
[Expand]
Inherited Methods
From class java.lang.Object

Fields

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.

Public Constructors

public LoadQueryInfluencers ()

public LoadQueryInfluencers (SessionFactoryImplementor sessionFactory)

Public Methods

public void disableFetchProfile (String name)

Throws
UnknownProfileException

public void disableFilter (String filterName)

public void enableFetchProfile (String name)

Throws
UnknownProfileException

public Filter enableFilter (String filterName)

public Set getEnabledFetchProfileNames ()

public Filter getEnabledFilter (String filterName)

public Set getEnabledFilterNames ()

Returns an unmodifiable Set of enabled filter names.

Returns
  • an unmodifiable Set of enabled filter names.

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

Throws
UnknownProfileException

public static String[] parseFilterParameterName (String filterParameterName)

public void setInternalFetchProfile (String internalFetchProfile)