org.hibernate.cache.internal

Class StandardQueryCache

java.lang.Object

org.hibernate.cache.internal.StandardQueryCache

All Implemented Interfaces:

QueryCache

public class StandardQueryCache
extends Object
implements QueryCache

The standard implementation of the Hibernate QueryCache interface. This implementation is very good at recognizing stale query results and and re-running queries when it detects this condition, re-caching the new results.

Author:

Gavin King, Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
StandardQueryCache(SessionFactoryOptions settings, Properties props, UpdateTimestampsCache updateTimestampsCache, String regionName) Constructs a StandardQueryCache instance

Method Summary

Modifier and Type	Method and Description
void	clear() Clear items from the query cache.
void	destroy() Destroy the cache.
List	get(QueryKey key, Type[] returnTypes, boolean isNaturalKeyLookup, Set<Serializable> spaces, SessionImplementor session) Get results from the cache.
QueryResultsRegion	getRegion() The underlying cache factory region being used.
protected boolean	isUpToDate(Set<Serializable> spaces, Long timestamp, SessionImplementor session)
boolean	put(QueryKey key, Type[] returnTypes, List result, boolean isNaturalKeyLookup, SessionImplementor session) Put a result into the query cache.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardQueryCache

public StandardQueryCache(SessionFactoryOptions settings,
                          Properties props,
                          UpdateTimestampsCache updateTimestampsCache,
                          String regionName)

Constructs a StandardQueryCache instance

Parameters:

settings - The SessionFactory settings.

props - Any properties

updateTimestampsCache - The update-timestamps cache to use.

regionName - The base query cache region name

Method Detail

getRegion

public QueryResultsRegion getRegion()

Description copied from interface: QueryCache

The underlying cache factory region being used.

Specified by:

getRegion in interface QueryCache

Returns:

The cache region.

destroy

public void destroy()

Description copied from interface: QueryCache

Destroy the cache.

Specified by:

destroy in interface QueryCache

clear

public void clear()
           throws CacheException

Description copied from interface: QueryCache

Clear items from the query cache.

Specified by:

clear in interface QueryCache

Throws:

CacheException - Indicates a problem delegating to the underlying cache.

put

public boolean put(QueryKey key,
                   Type[] returnTypes,
                   List result,
                   boolean isNaturalKeyLookup,
                   SessionImplementor session)
            throws HibernateException

Description copied from interface: QueryCache

Put a result into the query cache.

Specified by:

put in interface QueryCache

Parameters:

key - The cache key

returnTypes - The result types

result - The results to cache

isNaturalKeyLookup - Was this a natural id lookup?

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,
                Type[] returnTypes,
                boolean isNaturalKeyLookup,
                Set<Serializable> spaces,
                SessionImplementor session)
         throws HibernateException

Description copied from interface: QueryCache

Get results from the cache.

Specified by:

get in interface QueryCache

Parameters:

key - The cache key

returnTypes - The result types

isNaturalKeyLookup - Was this a natural id lookup?

spaces - The query spaces (used in invalidation plus validation checks)

session - The originating session

Returns:

The cached results; may be null.

Throws:

HibernateException - Indicates a problem delegating to the underlying cache.

isUpToDate

protected boolean isUpToDate(Set<Serializable> spaces,
                             Long timestamp,
                             SessionImplementor session)

toString

public String toString()

Overrides:

toString in class Object