Top Description Methods
org.hibernate.cache.spi

public Interface Region

Known Direct Subinterfaces
org.hibernate.cache.spi.DirectAccessRegion, org.hibernate.cache.spi.DomainDataRegion
Known Direct Implementers
org.hibernate.cache.spi.support.AbstractRegion
Imports
org.hibernate.boot.spi.SessionFactoryOptions, org.hibernate.cache.CacheException
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 TypeMethod and Description
public void
clear()

Clear all data cached in the region

public void
destroy()

The "end state" contract of the region's lifecycle.

public String
getName()

Retrieve the unqualified name of this region.

public RegionFactory
getRegionFactory()

The RegionFactory that generated this Region

Method Detail

clearback to summary
public void clear()

Clear all data cached in the region

destroyback to summary
public void destroy() throws CacheException

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

Exceptions
CacheException:
Indicates problem shutting down
getNameback to summary
public String getName()

Retrieve the unqualified name of this region.

getRegionFactoryback to summary
public RegionFactory getRegionFactory()

The RegionFactory that generated this Region