org.hibernate.cache.spi

Interface QueryCache

All Known Implementing Classes:

StandardQueryCache

public interface QueryCache

Defines the contract for caches capable of storing query results. These caches should only concern themselves with storing the matching result ids. The transactional semantics are necessarily less strict than the semantics of an item cache.

Author:

Gavin King

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.
boolean	put(QueryKey key, Type[] returnTypes, List result, boolean isNaturalKeyLookup, SessionImplementor session) Put a result into the query cache.

Method Detail

clear

void clear()
    throws CacheException

Clear items from the query cache.

Throws:

CacheException - Indicates a problem delegating to the underlying cache.

put

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

Put a result into the query cache.

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

List get(QueryKey key,
         Type[] returnTypes,
         boolean isNaturalKeyLookup,
         Set<Serializable> spaces,
         SessionImplementor session)
  throws HibernateException

Get results from the cache.

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.

destroy

void destroy()

Destroy the cache.

getRegion

QueryResultsRegion getRegion()

The underlying cache factory region being used.

Returns:

The cache region.