Top Description Inners 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.Arrays, .Objects, .Set, org.hibernate.engine.spi.SharedSessionContractImplementor, org.hibernate.query.spi.Limit, .QueryParameterBindings

A key that identifies a particular query with bound parameter values. This object is used as a key into the query results cache.

Note that the fields of this object must contain every explicit and implicit setting and parameter argument that affects the result list of the query, including things like the limit and offset and enabled filters.

Authors
Gavin King, Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
QueryKey.ParameterBindingsMemento

todo (6.0) : integrate work from original 6.0 branch

Field Summary

Modifier and TypeField and Description
private final String[]
private final Integer
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
private final QueryKey.ParameterBindingsMemento
private final String

Constructor Summary

AccessConstructor and Description
public
QueryKey(String sql, QueryKey.ParameterBindingsMemento parameterBindingsMemento, Integer firstRow, Integer maxRows, Set<String> enabledFilterNames)

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.
public static QueryKey
from(String sqlQueryString, Limit limit, QueryParameterBindings parameterBindings, SharedSessionContractImplementor session)

private int
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.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

enabledFilterNamesback to summary
private final String[] enabledFilterNames
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
parameterBindingsMementoback to summary
private final QueryKey.ParameterBindingsMemento parameterBindingsMemento
sqlQueryStringback to summary
private final String sqlQueryString

Constructor Detail

QueryKeyback to summary
public QueryKey(String sql, QueryKey.ParameterBindingsMemento parameterBindingsMemento, Integer firstRow, Integer maxRows, Set<String> enabledFilterNames)

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
@SuppressWarnings:RedundantIfStatement, EqualsWhichDoesntCheckParameterClass
fromback to summary
public static QueryKey from(String sqlQueryString, Limit limit, QueryParameterBindings parameterBindings, SharedSessionContractImplementor session)
generateHashCodeback to summary
private int generateHashCode()
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
org.hibernate.cache.spi back to summary

public Interface QueryKey.ParameterBindingsMemento

extends Serializable
Known Direct Implementers
org.hibernate.query.internal.QueryParameterBindingsImpl.ParameterBindingsMementoImpl

todo (6.0) : integrate work from original 6.0 branch