Package org.hibernate.cache.internal

Class QueryResultsCacheImpl

java.lang.Object

org.hibernate.cache.internal.QueryResultsCacheImpl

All Implemented Interfaces:

QueryResultsCache

public class QueryResultsCacheImpl
extends Object
implements QueryResultsCache

The standard implementation of the Hibernate QueryCache interface. Works hind-in-hand with TimestampsCache to help in recognizing stale query results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryResultsCacheImpl.CacheItem

Method Summary

Modifier and Type	Method	Description
List<?>	get(QueryKey key, String[] spaces, SharedSessionContractImplementor session)	Attempt to retrieve a cached query result list for the given QueryKey from the cache region, and then check if the cached results, if any, are stale.
List<?>	get(QueryKey key, Set<String> spaces, SharedSessionContractImplementor session)	Attempt to retrieve a cached query result list for the given QueryKey from the cache region, and then check if the cached results, if any, are stale.
QueryResultsRegion	getRegion()	The underlying cache region being used.
boolean	put(QueryKey key, List<?> results, SharedSessionContractImplementor session)	Store a result list of a query with the given QueryKey in the query result cache.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.cache.spi.QueryResultsCache

clear, destroy

Method Detail

getRegion

public QueryResultsRegion getRegion()

Description copied from interface: QueryResultsCache

The underlying cache region being used.

Specified by:

getRegion in interface QueryResultsCache

put

public boolean put(QueryKey key,
                   List<?> results,
                   SharedSessionContractImplementor session)
            throws HibernateException

Description copied from interface: QueryResultsCache

Store a result list of a query with the given QueryKey in the query result cache.

Specified by:

put in interface QueryResultsCache

Parameters:

key - The cache key uniquely identifying the query and its bound parameter arguments

results - The result list to cache

session - The originating session

Returns:

Whether the put actually happened.

Throws:

HibernateException - Indicates a problem delegating to the underlying cache.

get

public List<?> get(QueryKey key,
                   Set<String> spaces,
                   SharedSessionContractImplementor session)
            throws HibernateException

Description copied from interface: QueryResultsCache

Attempt to retrieve a cached query result list for the given QueryKey from the cache region, and then check if the cached results, if any, are stale. If there is no cached result list for the given key, or if the cached results are stale, return null.

Specified by:

get in interface QueryResultsCache

Parameters:

key - The cache key uniquely identifying the query and its bound parameter arguments

spaces - The query spaces which affect the results of the query (used to check if cached results are stale)

session - The originating session

Returns:

The cached results; may be null if there are no cached results for the given key, or if the results are stale.

Throws:

HibernateException - Indicates a problem delegating to the underlying cache.

get

public List<?> get(QueryKey key,
                   String[] spaces,
                   SharedSessionContractImplementor session)
            throws HibernateException

Description copied from interface: QueryResultsCache

Attempt to retrieve a cached query result list for the given QueryKey from the cache region, and then check if the cached results, if any, are stale. If there is no cached result list for the given key, or if the cached results are stale, return null.

Specified by:

get in interface QueryResultsCache

Parameters:

key - The cache key uniquely identifying the query and its bound parameter arguments

spaces - The query spaces which affect the results of the query (used to check if cached results are stale)

session - The originating session

Returns:

The cached results; may be null.

Throws:

HibernateException - Indicates a problem delegating to the underlying cache.

toString

public String toString()

Overrides:

toString in class Object