org.hibernate.cache.spi

Interface Region

All Known Subinterfaces:

DirectAccessRegion, DomainDataRegion, QueryResultsRegion, TimestampsRegion

All Known Implementing Classes:

AbstractDomainDataRegion, AbstractRegion, DirectAccessRegionTemplate, DomainDataRegionImpl, DomainDataRegionTemplate, QueryResultsRegionTemplate, TimestampsRegionTemplate

public interface Region

Contract for a named "region". The concept of a Region might not necessarily correlate to a specific concept in the underlying caching provider - it is just a thing that can be referenced by name later.

A region's name is "unqualified"; i.e. it is not prefixed by SessionFactoryOptions.getCacheRegionPrefix().

Region is the base contract defining some common characteristics regardless of the type of data intended to be stored within this Region. The more specific sub-types are DomainDataRegion (storing entity, collection and natural-id data) and DirectAccessRegion (storing query result and timestamp data).

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all data cached in the region
void	destroy() The "end state" contract of the region's lifecycle.
String	getName() Retrieve the unqualified name of this region.
RegionFactory	getRegionFactory() The RegionFactory that generated this Region

Method Detail

getName

String getName()

Retrieve the unqualified name of this region.

getRegionFactory

RegionFactory getRegionFactory()

The RegionFactory that generated this Region

clear

void clear()

Clear all data cached in the region

destroy

void destroy()
      throws CacheException

The "end state" contract of the region's lifecycle. Called during SessionFactory.close() to give the region a chance to cleanup.

Throws:

CacheException - Indicates problem shutting down