Top Description Methods
org.hibernate.cache.spi

public Interface DomainDataRegion

extends Region
Known Direct Implementers
org.hibernate.cache.spi.support.AbstractDomainDataRegion
Imports
org.hibernate.cache.spi.access.CollectionDataAccess, .EntityDataAccess, .NaturalIdDataAccess, org.hibernate.metamodel.model.domain.NavigableRole
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
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public CollectionDataAccess
getCollectionDataAccess(NavigableRole
The NavigableRole of the collection whose data we want to access
collectionRole)

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

public EntityDataAccess
getEntityDataAccess(NavigableRole
The root entity name for the hierarchy whose data we want to access
rootEntityRole)

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

public NaturalIdDataAccess
getNaturalIdDataAccess(NavigableRole
The NavigableRole of the root entity whose natural-id data we want to access
rootEntityRole)

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

Inherited from org.hibernate.cache.spi.Region:
cleardestroygetNamegetRegionFactory

Method Detail

getCollectionDataAccessback to summary
public CollectionDataAccess getCollectionDataAccess(NavigableRole collectionRole)

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

API Note

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

Parameters
collectionRole:NavigableRole

The NavigableRole of the collection whose data we want to access

Exceptions
CacheException:
If the provider cannot provide the requested access
getEntityDataAccessback to summary
public EntityDataAccess getEntityDataAccess(NavigableRole rootEntityRole)

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

API Note

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

Parameters
rootEntityRole:NavigableRole

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

Exceptions
CacheException:
If the provider cannot provide the requested access
getNaturalIdDataAccessback to summary
public NaturalIdDataAccess getNaturalIdDataAccess(NavigableRole rootEntityRole)

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

API Note

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

Parameters
rootEntityRole:NavigableRole

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

Exceptions
CacheException:
If the provider cannot provide the requested access