org.hibernate.cache.ehcache.internal.regions

Class EhcacheQueryResultsRegion

java.lang.Object

org.hibernate.cache.ehcache.internal.regions.EhcacheDataRegion

org.hibernate.cache.ehcache.internal.regions.EhcacheQueryResultsRegion

All Implemented Interfaces:

GeneralDataRegion, QueryResultsRegion, Region

public class EhcacheQueryResultsRegion
extends EhcacheDataRegion
implements QueryResultsRegion

A query results region specific wrapper around an Ehcache instance.

Constructor Summary

Constructors

Constructor and Description
EhcacheQueryResultsRegion(EhcacheAccessStrategyFactory accessStrategyFactory, net.sf.ehcache.Ehcache underlyingCache, java.util.Properties properties) Constructs an EhcacheQueryResultsRegion around the given underlying cache.

Method Summary

Modifier and Type	Method and Description
void	evict(java.lang.Object key) Evict an item from the cache immediately (without regard for transaction isolation).
void	evictAll() Evict all contents of this particular cache region (without regard for transaction isolation).
java.lang.Object	get(SessionImplementor session, java.lang.Object key) Get an item from the cache.
void	put(SessionImplementor session, java.lang.Object key, java.lang.Object value) Put an item into the cache.

Methods inherited from class org.hibernate.cache.ehcache.internal.regions.EhcacheDataRegion

contains, destroy, getAccessStrategyFactory, getCache, getEhcache, getElementCountInMemory, getElementCountOnDisk, getName, getSizeInMemory, getTimeout, nextTimestamp, toMap

Methods inherited from class java.lang.Object

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

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

evict, evictAll, get, put

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

contains, destroy, getElementCountInMemory, getElementCountOnDisk, getName, getSizeInMemory, getTimeout, nextTimestamp, toMap

Constructor Detail

EhcacheQueryResultsRegion

public EhcacheQueryResultsRegion(EhcacheAccessStrategyFactory accessStrategyFactory,
                                 net.sf.ehcache.Ehcache underlyingCache,
                                 java.util.Properties properties)

Constructs an EhcacheQueryResultsRegion around the given underlying cache.

Parameters:

accessStrategyFactory - The factory for building needed CollectionRegionAccessStrategy instance

underlyingCache - The ehcache cache instance

properties - Any additional[ properties

Method Detail

get

public java.lang.Object get(SessionImplementor session,
                            java.lang.Object key)
                     throws CacheException

Description copied from interface: GeneralDataRegion

Get an item from the cache.

Specified by:

get in interface GeneralDataRegion

key - The key of the item to be retrieved.

Returns:

the cached object or null

Throws:

CacheException - Indicates a problem accessing the item or region.

put

public void put(SessionImplementor session,
                java.lang.Object key,
                java.lang.Object value)
         throws CacheException

Description copied from interface: GeneralDataRegion

Put an item into the cache.

Specified by:

put in interface GeneralDataRegion

key - The key under which to cache the item.

value - The item to cache.

Throws:

CacheException - Indicates a problem accessing the region.

evict

public void evict(java.lang.Object key)
           throws CacheException

Description copied from interface: GeneralDataRegion

Evict an item from the cache immediately (without regard for transaction isolation).

Specified by:

evict in interface GeneralDataRegion

Parameters:

key - The key of the item to remove

Throws:

CacheException - Indicates a problem accessing the item or region.

evictAll

public void evictAll()
              throws CacheException

Description copied from interface: GeneralDataRegion

Evict all contents of this particular cache region (without regard for transaction isolation).

Specified by:

evictAll in interface GeneralDataRegion

Throws:

CacheException - Indicates problem accessing the region.