org.hibernate.cache.spi

Class QueryKey

java.lang.Object

org.hibernate.cache.spi.QueryKey

All Implemented Interfaces:

Serializable

public class QueryKey
extends Object
implements Serializable

A key that identifies a particular query with bound parameter values. This is the object Hibernate uses as its key into its query cache.

Author:

Gavin King, Steve Ebersole

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static QueryKey	generateQueryKey(String queryString, QueryParameters queryParameters, Set filterKeys, SessionImplementor session, CacheableResultTransformer customTransformer) Generates a QueryKey.
Map	getNamedParameters() Provide (unmodifiable) access to the named parameters that are part of this query.
CacheableResultTransformer	getResultTransformer() Provides access to the explicitly user-provided result transformer.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

generateQueryKey

public static QueryKey generateQueryKey(String queryString,
                                        QueryParameters queryParameters,
                                        Set filterKeys,
                                        SessionImplementor session,
                                        CacheableResultTransformer customTransformer)

Generates a QueryKey.

Parameters:

queryString - The sql query string.

queryParameters - The query parameters

filterKeys - The keys of any enabled filters.

session - The current session.

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

Returns:

The generate query cache key.

getResultTransformer

public CacheableResultTransformer getResultTransformer()

Provides access to the explicitly user-provided result transformer.

Returns:

The result transformer.

getNamedParameters

public Map getNamedParameters()

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

Returns:

The (unmodifiable) map of named parameters

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object