Package org.hibernate.cache.spi

Interface DomainDataRegion

All Superinterfaces:

Region

All Known Implementing Classes:

AbstractDomainDataRegion, DomainDataRegionImpl, DomainDataRegionTemplate

public interface DomainDataRegion
extends Region

A Region for cacheable domain data - entity, collection, natural-id. Generally speaking, this type of data has: * specific key and value wrapping that needs to be applied * specific access patterns (EntityDataAccess, etc), including some form of locking

Method Summary

Modifier and Type	Method	Description
CollectionDataAccess	getCollectionDataAccess(NavigableRole collectionRole)	Build a CollectionRegionAccess instance representing access to collection data stored in this cache region using the given AccessType.
EntityDataAccess	getEntityDataAccess(NavigableRole rootEntityRole)	Build a EntityRegionAccess instance representing access to entity data stored in this cache region using the given AccessType.
NaturalIdDataAccess	getNaturalIdDataAccess(NavigableRole rootEntityRole)	Build a NaturalIdRegionAccess instance representing access to natural-id data stored in this cache region using the given AccessType.

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

clear, destroy, getName, getRegionFactory

Method Detail

getEntityDataAccess

EntityDataAccess getEntityDataAccess(NavigableRole rootEntityRole)

Build a EntityRegionAccess instance representing access to entity data stored in this cache region using the given AccessType.

Parameters:

rootEntityRole - The root entity name for the hierarchy whose data we want to access

Throws:

CacheException - If the provider cannot provide the requested access

ApiNote:

Calling this method is illegal if the given entity is not cached

getNaturalIdDataAccess

NaturalIdDataAccess getNaturalIdDataAccess(NavigableRole rootEntityRole)

Build a NaturalIdRegionAccess instance representing access to natural-id data stored in this cache region using the given AccessType.

Parameters:

rootEntityRole - The NavigableRole of the root entity whose natural-id data we want to access

Throws:

CacheException - If the provider cannot provide the requested access

ApiNote:

Calling this method is illegal if the given entity is not cached

getCollectionDataAccess

CollectionDataAccess getCollectionDataAccess(NavigableRole collectionRole)

Build a CollectionRegionAccess instance representing access to collection data stored in this cache region using the given AccessType.

Parameters:

collectionRole - The NavigableRole of the collection whose data we want to access

Throws:

CacheException - If the provider cannot provide the requested access

ApiNote:

Calling this method is illegal if the given entity is not cached