org.hibernate.cache.jbc.query

Class QueryResultsRegionImpl

java.lang.Object

org.hibernate.cache.jbc.BasicRegionAdapter

org.hibernate.cache.jbc.TransactionalDataRegionAdapter

org.hibernate.cache.jbc.query.QueryResultsRegionImpl

All Implemented Interfaces:

GeneralDataRegion, QueryResultsRegion, Region, TransactionalDataRegion

public class QueryResultsRegionImpl
extends TransactionalDataRegionAdapter
implements QueryResultsRegion

Defines the behavior of the query cache regions for JBossCache 2.x.

Version:

$Revision$

Author:

Brian Stansberry

Field Summary

Fields

Modifier and Type	Field and Description
static String	LEGACY_QUERY_CACHE_LOCAL_ONLY_PROP
static String	QUERY_CACHE_LOCAL_ONLY_PROP
static String	TYPE

Fields inherited from class org.hibernate.cache.jbc.TransactionalDataRegionAdapter

metadata

Fields inherited from class org.hibernate.cache.jbc.BasicRegionAdapter

currentView, internalFqn, invalidateState, invalidationMutex, ITEM, jbcCache, log, memberId, optimistic, regionFqn, regionName, regionRoot, regionRootMutex, replication, transactionManager

Constructor Summary

Constructors

Constructor and Description
QueryResultsRegionImpl(org.jboss.cache.Cache jbcCache, String regionName, String regionPrefix, Properties properties) Create a new QueryResultsRegionImpl.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.jboss.cache.Fqn<String>	createRegionFqn(String regionName, String regionPrefix)
void	evict(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).
Object	get(Object key) Get an item from the cache.
void	put(Object key, Object value) Put an item into the cache.

Methods inherited from class org.hibernate.cache.jbc.TransactionalDataRegionAdapter

getCacheDataDescription, isTransactionAware

Methods inherited from class org.hibernate.cache.jbc.BasicRegionAdapter

activateLocalClusterNode, checkValid, contains, deactivateLocalNode, destroy, ensureRegionRootExists, escapeRegionName, getCacheInstance, getElementCountInMemory, getElementCountOnDisk, getMemberId, getName, getNonLockingDataVersionOption, getRegionFqn, getSizeInMemory, getTimeout, getTypeFirstRegionFqn, getTypeLastRegionFqn, handleEvictAllInvalidation, handleEvictAllModification, nextTimestamp, nodeInvalidated, nodeModified, resume, suspend, suspendAndGet, toMap, viewChanged

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.Region

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

Field Detail

QUERY_CACHE_LOCAL_ONLY_PROP

public static final String QUERY_CACHE_LOCAL_ONLY_PROP

See Also:

Constant Field Values

LEGACY_QUERY_CACHE_LOCAL_ONLY_PROP

public static final String LEGACY_QUERY_CACHE_LOCAL_ONLY_PROP

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

QueryResultsRegionImpl

public QueryResultsRegionImpl(org.jboss.cache.Cache jbcCache,
                      String regionName,
                      String regionPrefix,
                      Properties properties)

Create a new QueryResultsRegionImpl.

Parameters:

jbcCache - The JBC cache instance to use to store the query results

regionName - The name of the region (within the JBC cache)

regionPrefix - Any region prefix to apply

properties - The configuration properties.

Method Detail

evict

public void evict(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.

get

public Object get(Object key)
           throws CacheException

Description copied from interface: GeneralDataRegion

Get an item from the cache.

Specified by:

get in interface GeneralDataRegion

Parameters:

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(Object key,
       Object value)
         throws CacheException

Description copied from interface: GeneralDataRegion

Put an item into the cache.

Specified by:

put in interface GeneralDataRegion

Parameters:

key - The key under which to cache the item.

value - The item to cache.

Throws:

CacheException - Indicates a problem accessing the region.

createRegionFqn

protected org.jboss.cache.Fqn<String> createRegionFqn(String regionName,
                                          String regionPrefix)

Specified by:

createRegionFqn in class BasicRegionAdapter