Top Description Fields Constructors Methods
org.hibernate.cache.spi

public Class QueryKey

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.IOException, .Serializable, java.util.Collections, .Map, .Objects, .Set, org.hibernate.engine.spi.QueryParameters, .RowSelection, .SharedSessionContractImplementor, .TypedValue, org.hibernate.internal.util.collections.CollectionHelper, org.hibernate.transform.CacheableResultTransformer, org.hibernate.type.Type
A key that identifies a particular query with bound parameter values. This is the object Hibernate uses as its key into its query cache.
Authors
Gavin King, Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final CacheableResultTransformer
customTransformer

private final Set<E>
filterKeys

private final Integer
firstRow

private transient int
hashCode

For performance reasons, the hashCode is cached; however, it is marked transient so that it can be recalculated as part of the serialization process which allows distributed query caches to work properly.

private final Integer
maxRows

private final Map<K, V>
namedParameters

private final Type[]
positionalParameterTypes

private final Object[]
positionalParameterValues

private final String
sqlQueryString

private final String
tenantIdentifier

Constructor Summary

AccessConstructor and Description
pack-priv
QueryKey(String
The sql query string.
sqlQueryString, Type[]
Positional parameter types.
positionalParameterTypes, Object[]
Positional parameter values.
positionalParameterValues, Map<K, V>
Named parameters.
namedParameters, Integer
First row selection, if any.
firstRow, Integer
Max-rows selection, if any.
maxRows, Set<E>
Enabled filter keys, if any.
filterKeys, String
The tenant identifier in effect for this query, or null
tenantIdentifier, CacheableResultTransformer
Custom result transformer, if one.
customTransformer)

Package-protected constructor.

Method Summary

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

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
private int
generateHashCode()

public static QueryKey

Returns:

The generate query cache key.
generateQueryKey(String
The sql query string.
queryString, QueryParameters
The query parameters
queryParameters, Set<E>
The keys of any enabled filters.
filterKeys, SharedSessionContractImplementor
The current session.
session, CacheableResultTransformer
The result transformer; should be null if data is not transformed before being cached.
customTransformer)

Generates a QueryKey.

public Map<K, V>

Returns:

The (unmodifiable) map of named parameters
getNamedParameters()

Provide (unmodifiable) access to the named parameters that are part of this query.

public CacheableResultTransformer

Returns:

The result transformer.
getResultTransformer()

Provides access to the explicitly user-provided result transformer.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
private void
readObject(ObjectInputStream
The object input stream.
in)

Deserialization hook used to re-init the cached hashcode which is needed for proper clustering support.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

customTransformerback to summary
private final CacheableResultTransformer customTransformer
filterKeysback to summary
private final Set<E> filterKeys
firstRowback to summary
private final Integer firstRow
hashCodeback to summary
private transient int hashCode

For performance reasons, the hashCode is cached; however, it is marked transient so that it can be recalculated as part of the serialization process which allows distributed query caches to work properly.

maxRowsback to summary
private final Integer maxRows
namedParametersback to summary
private final Map<K, V> namedParameters
positionalParameterTypesback to summary
private final Type[] positionalParameterTypes
positionalParameterValuesback to summary
private final Object[] positionalParameterValues
sqlQueryStringback to summary
private final String sqlQueryString
tenantIdentifierback to summary
private final String tenantIdentifier

Constructor Detail

QueryKeyback to summary
pack-priv QueryKey(String sqlQueryString, Type[] positionalParameterTypes, Object[] positionalParameterValues, Map<K, V> namedParameters, Integer firstRow, Integer maxRows, Set<E> filterKeys, String tenantIdentifier, CacheableResultTransformer customTransformer)

Package-protected constructor.

Parameters
sqlQueryString:String

The sql query string.

positionalParameterTypes:Type[]

Positional parameter types.

positionalParameterValues:Object[]

Positional parameter values.

namedParameters:Map<K, V>

Named parameters.

firstRow:Integer

First row selection, if any.

maxRows:Integer

Max-rows selection, if any.

filterKeys:Set<E>

Enabled filter keys, if any.

tenantIdentifier:String

The tenant identifier in effect for this query, or null

customTransformer:CacheableResultTransformer

Custom result transformer, if one.

Method Detail

equalsback to summary
public boolean equals(Object other)

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
other: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
generateHashCodeback to summary
private int generateHashCode()
generateQueryKeyback to summary
public static QueryKey generateQueryKey(String queryString, QueryParameters queryParameters, Set<E> filterKeys, SharedSessionContractImplementor session, CacheableResultTransformer customTransformer)

Generates a QueryKey.

Parameters
queryString:String

The sql query string.

queryParameters:QueryParameters

The query parameters

filterKeys:Set<E>

The keys of any enabled filters.

session:SharedSessionContractImplementor

The current session.

customTransformer:CacheableResultTransformer

The result transformer; should be null if data is not transformed before being cached.

Returns:QueryKey

The generate query cache key.

getNamedParametersback to summary
public Map<K, V> getNamedParameters()

Provide (unmodifiable) access to the named parameters that are part of this query.

Returns:Map<K, V>

The (unmodifiable) map of named parameters

Annotations
@SuppressWarnings:unchecked
getResultTransformerback to summary
public CacheableResultTransformer getResultTransformer()

Provides access to the explicitly user-provided result transformer.

Returns:CacheableResultTransformer

The result transformer.

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
readObjectback to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

Deserialization hook used to re-init the cached hashcode which is needed for proper clustering support.

Parameters
in:ObjectInputStream

The object input stream.

Exceptions
IOException:
Thrown by normal deserialization
ClassNotFoundException:
Thrown by normal deserialization
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override