Top Description Inners Fields Constructors Methods
org.hibernate.query.internal

public Class QueryInterpretationCacheStandardImpl

extends Object
implements QueryInterpretationCache
Class Inheritance
All Implemented Interfaces
org.hibernate.query.spi.QueryInterpretationCache
Imports
java.util.concurrent.TimeUnit, java.util.function.Function, .Supplier, org.hibernate.internal.util.collections.BoundedConcurrentHashMap, org.hibernate.query.QueryLogging, org.hibernate.query.hql.HqlTranslator, org.hibernate.query.spi.HqlInterpretation, .NonSelectQueryPlan, .ParameterMetadataImplementor, .QueryInterpretationCache, .QueryPlan, .SelectQueryPlan, .SimpleHqlInterpretationImpl, org.hibernate.query.sql.spi.ParameterInterpretation, org.hibernate.query.sqm.internal.DomainParameterXref, org.hibernate.query.sqm.tree.SqmStatement, org.hibernate.stat.spi.StatisticsImplementor, org.jboss.logging.Logger

Standard QueryInterpretationCache implementation
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final BoundedConcurrentHashMap<Object, HqlInterpretation>
private static final Logger
private final BoundedConcurrentHashMap<String, ParameterInterpretation>
private final BoundedConcurrentHashMap<QueryInterpretationCache.Key, QueryPlan>
queryPlanCache

the cache of the actual plans...

private final Supplier<StatisticsImplementor>

Constructor Summary

AccessConstructor and Description
public
QueryInterpretationCacheStandardImpl(int maxQueryPlanCount, Supplier<StatisticsImplementor> statisticsSupplier)

Method Summary

Modifier and TypeMethod and Description
public void
public void
close()

Implements org.hibernate.query.spi.QueryInterpretationCache.close.

Close the cache when the SessionFactory is closed.
protected static HqlInterpretation
createHqlInterpretation(String queryString, Class<?> expectedResultType, HqlTranslator translator, StatisticsImplementor statistics)

public NonSelectQueryPlan
public int
public int
public boolean
public HqlInterpretation
public HqlInterpretation
public ParameterInterpretation
public <R> SelectQueryPlan<R>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

hqlInterpretationCacheback to summary
private final BoundedConcurrentHashMap<Object, HqlInterpretation> hqlInterpretationCache
logback to summary
private static final Logger log
nativeQueryParamCacheback to summary
private final BoundedConcurrentHashMap<String, ParameterInterpretation> nativeQueryParamCache
queryPlanCacheback to summary
private final BoundedConcurrentHashMap<QueryInterpretationCache.Key, QueryPlan> queryPlanCache

the cache of the actual plans...

statisticsSupplierback to summary
private final Supplier<StatisticsImplementor> statisticsSupplier

Constructor Detail

QueryInterpretationCacheStandardImplback to summary
public QueryInterpretationCacheStandardImpl(int maxQueryPlanCount, Supplier<StatisticsImplementor> statisticsSupplier)

Method Detail

cacheNonSelectQueryPlanback to summary
public void cacheNonSelectQueryPlan(QueryInterpretationCache.Key key, NonSelectQueryPlan plan)

Implements org.hibernate.query.spi.QueryInterpretationCache.cacheNonSelectQueryPlan.

Annotations
@Override
closeback to summary
public void close()

Implements org.hibernate.query.spi.QueryInterpretationCache.close.

Doc from org.hibernate.query.spi.QueryInterpretationCache.close.

Close the cache when the SessionFactory is closed.

Note that depending on the cache strategy implementation chosen, clearing the cache might not reclaim all the memory.

Typically, when using LIRS, clearing the cache only invalidates the entries but the outdated entries are kept in memory until they are replaced by others. It is not considered a memory leak as the cache is bounded.

Annotations
@Override
createHqlInterpretationback to summary
protected static HqlInterpretation createHqlInterpretation(String queryString, Class<?> expectedResultType, HqlTranslator translator, StatisticsImplementor statistics)
getNonSelectQueryPlanback to summary
public NonSelectQueryPlan getNonSelectQueryPlan(QueryInterpretationCache.Key key)

Implements org.hibernate.query.spi.QueryInterpretationCache.getNonSelectQueryPlan.

Annotations
@Override
getNumberOfCachedHqlInterpretationsback to summary
public int getNumberOfCachedHqlInterpretations()

Implements org.hibernate.query.spi.QueryInterpretationCache.getNumberOfCachedHqlInterpretations.

Annotations
@Override
getNumberOfCachedQueryPlansback to summary
public int getNumberOfCachedQueryPlans()

Implements org.hibernate.query.spi.QueryInterpretationCache.getNumberOfCachedQueryPlans.

Annotations
@Override
isEnabledback to summary
public boolean isEnabled()

Implements org.hibernate.query.spi.QueryInterpretationCache.isEnabled.

Annotations
@Override
resolveHqlInterpretationback to summary
public HqlInterpretation resolveHqlInterpretation(String queryString, Class<?> expectedResultType, Function<String, SqmStatement<?>> creator)

Implements org.hibernate.query.spi.QueryInterpretationCache.resolveHqlInterpretation.

Annotations
@Override
resolveHqlInterpretationback to summary
public HqlInterpretation resolveHqlInterpretation(String queryString, Class<?> expectedResultType, HqlTranslator translator)

Overrides default org.hibernate.query.spi.QueryInterpretationCache.resolveHqlInterpretation.

Annotations
@Override
resolveNativeQueryParametersback to summary
public ParameterInterpretation resolveNativeQueryParameters(String queryString, Function<String, ParameterInterpretation> creator)

Implements org.hibernate.query.spi.QueryInterpretationCache.resolveNativeQueryParameters.

Annotations
@Override
resolveSelectQueryPlanback to summary
public <R> SelectQueryPlan<R> resolveSelectQueryPlan(QueryInterpretationCache.Key key, Supplier<SelectQueryPlan<R>> creator)

Implements org.hibernate.query.spi.QueryInterpretationCache.resolveSelectQueryPlan.

Annotations
@Override
org.hibernate.query.internal back to summary

private final Class QueryInterpretationCacheStandardImpl.HqlInterpretationCacheKey

extends Object
Class Inheritance
  • java.lang.Object
  • org.hibernate.query.internal.QueryInterpretationCacheStandardImpl.HqlInterpretationCacheKey

Field Summary

Modifier and TypeField and Description
private final Class<?>
private final String

Constructor Summary

AccessConstructor and Description
public
HqlInterpretationCacheKey(String queryString, Class<?> expectedResultType)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

expectedResultTypeback to summary
private final Class<?> expectedResultType
queryStringback to summary
private final String queryString

Constructor Detail

HqlInterpretationCacheKeyback to summary
public HqlInterpretationCacheKey(String queryString, Class<?> expectedResultType)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override