public Class QueryPlanCache

public void cleanup()

Clean up the caches 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.

getFilterQueryPlan	back to summary
public FilterQueryPlan getFilterQueryPlan(String filterString, String collectionRole, boolean shallow, Map<String, Filter> enabledFilters) throws QueryException, MappingException Get the query plan for the given collection HQL filter fragment, creating it and caching it if not already cached Parameters filterString:String The HQL filter fragment collectionRole:String The collection being filtered shallow:boolean Whether the execution will be shallow enabledFilters:Map<String, Filter> The filters enabled on the Session Returns:FilterQueryPlan The query plan Annotations @SuppressWarnings:unchecked Exceptions QueryException: Indicates a problem translating the query MappingException: Indicates a problem translating the query

getFilterQueryPlan

public FilterQueryPlan getFilterQueryPlan(String filterString, String collectionRole, boolean shallow, Map<String, Filter> enabledFilters) throws QueryException, MappingException

Get the query plan for the given collection HQL filter fragment, creating it and caching it if not already cached

Parameters

filterString:String: The HQL filter fragment
collectionRole:String: The collection being filtered
shallow:boolean: Whether the execution will be shallow
enabledFilters:Map<String, Filter>: The filters enabled on the Session

Returns:FilterQueryPlan

The query plan

Annotations

@SuppressWarnings:unchecked

Exceptions

QueryException:: Indicates a problem translating the query
MappingException:: Indicates a problem translating the query

getHQLQueryPlan	back to summary
public HQLQueryPlan getHQLQueryPlan(String queryString, boolean shallow, Map<String, Filter> enabledFilters) throws QueryException, MappingException Get the query plan for the given HQL query, creating it and caching it if not already cached Parameters queryString:String The HQL query string shallow:boolean Whether the execution will be shallow enabledFilters:Map<String, Filter> The filters enabled on the Session Returns:HQLQueryPlan The query plan Annotations @SuppressWarnings:unchecked Exceptions QueryException: Indicates a problem translating the query MappingException: Indicates a problem translating the query

getHQLQueryPlan

public HQLQueryPlan getHQLQueryPlan(String queryString, boolean shallow, Map<String, Filter> enabledFilters) throws QueryException, MappingException

Get the query plan for the given HQL query, creating it and caching it if not already cached

Parameters

queryString:String: The HQL query string
shallow:boolean: Whether the execution will be shallow
enabledFilters:Map<String, Filter>: The filters enabled on the Session

Returns:HQLQueryPlan

The query plan

Annotations

@SuppressWarnings:unchecked

Exceptions

QueryException:: Indicates a problem translating the query
MappingException:: Indicates a problem translating the query

getNativeQueryInterpreter	back to summary
public NativeQueryInterpreter getNativeQueryInterpreter()

getNativeSQLQueryPlan	back to summary
public NativeSQLQueryPlan getNativeSQLQueryPlan(final NativeSQLQuerySpecification spec) Get the query plan for a native SQL query, creating it and caching it if not already cached Parameters spec:NativeSQLQuerySpecification The native SQL query specification Returns:NativeSQLQueryPlan The query plan Annotations @SuppressWarnings:unchecked Exceptions QueryException: Indicates a problem translating the query MappingException: Indicates a problem translating the query

getNativeSQLQueryPlan

public NativeSQLQueryPlan getNativeSQLQueryPlan(final NativeSQLQuerySpecification spec)

Get the query plan for a native SQL query, creating it and caching it if not already cached

Parameters

spec:NativeSQLQuerySpecification: The native SQL query specification

Returns:NativeSQLQueryPlan

The query plan

Annotations

@SuppressWarnings:unchecked

Exceptions

QueryException:: Indicates a problem translating the query
MappingException:: Indicates a problem translating the query

getSQLParameterMetadata

public ParameterMetadata getSQLParameterMetadata(final String query, boolean isOrdinalParameterZeroBased)

Obtain the parameter metadata for given native-sql query.

for native-sql queries, the param metadata is determined outside any relation to a query plan, because query plan creation and/or retrieval for a native-sql query depends on all of the return types having been set, which might not be the case up-front when param metadata would be most useful

Parameters

query:String: The query

Returns:ParameterMetadata

The parameter metadata

org.hibernate.engine.query.spi back to summary

private Class QueryPlanCache.DynamicFilterKey

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.hibernate.engine.query.spi.QueryPlanCache.DynamicFilterKey

All Implemented Interfaces

Field Summary

Modifier and Type	Field and Description
private final String	filterName
private final int	hashCode
private final Map<String, Integer>	parameterMetadata

Constructor Summary

Access	Constructor and Description
private	DynamicFilterKey(FilterImpl filter)

Method Summary

Modifier and Type	Method 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:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

filterName	back to summary
private final String filterName

hashCode	back to summary
private final int hashCode

parameterMetadata	back to summary
private final Map<String, Integer> parameterMetadata

Constructor Detail

DynamicFilterKey	back to summary
private DynamicFilterKey(FilterImpl filter)

Method Detail

equals back to summary

equals	back 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

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

hashCode back to summary

hashCode	back 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

public int hashCode()

Overrides 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

org.hibernate.engine.query.spi back to summary

private Class QueryPlanCache.FilterQueryPlanKey

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.hibernate.engine.query.spi.QueryPlanCache.FilterQueryPlanKey

All Implemented Interfaces

Field Summary

Modifier and Type	Field and Description
private final String	collectionRole
private final Set<String>	filterNames
private final int	hashCode
private final String	query
private final boolean	shallow

Constructor Summary

Access	Constructor and Description
public	FilterQueryPlanKey(String query, String collectionRole, boolean shallow, Map<K, V> enabledFilters)

Method Summary

Modifier and Type	Method 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:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

collectionRole	back to summary
private final String collectionRole

filterNames	back to summary
private final Set<String> filterNames

hashCode	back to summary
private final int hashCode

query	back to summary
private final String query

shallow	back to summary
private final boolean shallow

Constructor Detail

FilterQueryPlanKey	back to summary
public FilterQueryPlanKey(String query, String collectionRole, boolean shallow, Map<K, V> enabledFilters) Annotations @SuppressWarnings:unchecked

Method Detail

equals back to summary

equals	back 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

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.

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

hashCode back to summary

hashCode	back 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

public int hashCode()

Overrides 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

org.hibernate.engine.query.spi back to summary

private Class QueryPlanCache.HQLQueryPlanKey

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.hibernate.engine.query.spi.QueryPlanCache.HQLQueryPlanKey

All Implemented Interfaces

Field Summary

Modifier and Type	Field and Description
private final Set<QueryPlanCache.DynamicFilterKey>	filterKeys
private final int	hashCode
private final String	query
private final boolean	shallow

Constructor Summary

Access	Constructor and Description
public	HQLQueryPlanKey(String query, boolean shallow, Map<K, V> enabledFilters)

Method Summary

Modifier and Type	Method 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:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

filterKeys	back to summary
private final Set<QueryPlanCache.DynamicFilterKey> filterKeys

hashCode	back to summary
private final int hashCode

query	back to summary
private final String query

shallow	back to summary
private final boolean shallow

Constructor Detail

HQLQueryPlanKey	back to summary
public HQLQueryPlanKey(String query, boolean shallow, Map<K, V> enabledFilters)

Method Detail

equals back to summary

equals	back 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

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.

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

hashCode back to summary

hashCode	back 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

public int hashCode()

Overrides 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

org.hibernate.engine.query.spi back to summary

private Class QueryPlanCache.ParameterMetadataKey

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.hibernate.engine.query.spi.QueryPlanCache.ParameterMetadataKey

All Implemented Interfaces

Field Summary

Modifier and Type	Field and Description
private final int	hashCode
private final boolean	isOrdinalParameterZeroBased
private final String	query

Constructor Summary

Access	Constructor and Description
public	ParameterMetadataKey(String query, boolean isOrdinalParameterZeroBased)

Method Summary

Modifier and Type	Method 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:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

hashCode	back to summary
private final int hashCode

isOrdinalParameterZeroBased	back to summary
private final boolean isOrdinalParameterZeroBased

query	back to summary
private final String query

Constructor Detail

ParameterMetadataKey	back to summary
public ParameterMetadataKey(String query, boolean isOrdinalParameterZeroBased)

Method Detail

equals back 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.

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

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.