org.hibernate.cache.ehcache.internal.regions

Class EhcacheCollectionRegion

java.lang.Object

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

org.hibernate.cache.ehcache.internal.regions.EhcacheTransactionalDataRegion

org.hibernate.cache.ehcache.internal.regions.EhcacheCollectionRegion

All Implemented Interfaces:

CollectionRegion, Region, TransactionalDataRegion

public class EhcacheCollectionRegion
extends EhcacheTransactionalDataRegion
implements CollectionRegion

A collection region specific wrapper around an Ehcache instance.

This implementation returns Ehcache specific access strategy instances for all the non-transactional access types. Transactional access is not supported.

Field Summary

Fields inherited from class org.hibernate.cache.ehcache.internal.regions.EhcacheTransactionalDataRegion

metadata

Constructor Summary

Constructors

Constructor and Description
EhcacheCollectionRegion(EhcacheAccessStrategyFactory accessStrategyFactory, net.sf.ehcache.Ehcache underlyingCache, Settings settings, CacheDataDescription metadata, Properties properties) Constructs an EhcacheCollectionRegion around the given underlying cache.

Method Summary

Methods

Modifier and Type	Method and Description
CollectionRegionAccessStrategy	buildAccessStrategy(AccessType accessType) Build an access strategy for the requested access type.

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

clear, get, getCacheDataDescription, getSettings, isTransactionAware, locksAreIndependentOfCache, put, readLock, readUnlock, remove, writeLock, writeUnlock

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

getCacheDataDescription, isTransactionAware

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

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

Constructor Detail

EhcacheCollectionRegion

public EhcacheCollectionRegion(EhcacheAccessStrategyFactory accessStrategyFactory,
                       net.sf.ehcache.Ehcache underlyingCache,
                       Settings settings,
                       CacheDataDescription metadata,
                       Properties properties)

Constructs an EhcacheCollectionRegion around the given underlying cache.

Parameters:

accessStrategyFactory - The factory for building needed CollectionRegionAccessStrategy instance

underlyingCache - The ehcache cache instance

settings - The Hibernate settings

metadata - Metadata about the data to be cached in this region

properties - Any additional[ properties

Method Detail

buildAccessStrategy

public CollectionRegionAccessStrategy buildAccessStrategy(AccessType accessType)
                                                   throws CacheException

Description copied from interface: CollectionRegion

Build an access strategy for the requested access type.

Specified by:

buildAccessStrategy in interface CollectionRegion

Parameters:

accessType - The type of access strategy to build; never null.

Returns:

The appropriate strategy contract for accessing this region for the requested type of access.

Throws:

CacheException - Usually indicates mis-configuration.