org.hibernate.cache.spi.support

Class AbstractDomainDataRegion

java.lang.Object

org.hibernate.cache.spi.support.AbstractRegion

org.hibernate.cache.spi.support.AbstractDomainDataRegion

All Implemented Interfaces:

DomainDataRegion, Region

Direct Known Subclasses:

DomainDataRegionTemplate

public abstract class AbstractDomainDataRegion
extends AbstractRegion
implements DomainDataRegion

Author:

Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractDomainDataRegion.Destructible Optional interface caching implementors can implement in their CachedDomainDataAccess impls to automatically have them destroyed when this region is destroyed

Constructor Summary

Constructors

Constructor and Description
AbstractDomainDataRegion(DomainDataRegionConfig regionConfig, RegionFactory regionFactory, CacheKeysFactory defaultKeysFactory, DomainDataRegionBuildingContext buildingContext)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all data cached in the region
protected void	completeInstantiation(DomainDataRegionConfig regionConfig, DomainDataRegionBuildingContext buildingContext) Should be called at the end of the subtype's constructor, or at least after the `#super(...)` (aka, this type's constructor) call.
void	destroy() The "end state" contract of the region's lifecycle.
protected abstract CollectionDataAccess	generateCollectionAccess(CollectionDataCachingConfig cachingConfig)
protected abstract EntityDataAccess	generateEntityAccess(EntityDataCachingConfig entityAccessConfig)
protected abstract NaturalIdDataAccess	generateNaturalIdAccess(NaturalIdDataCachingConfig naturalIdAccessConfig)
CollectionDataAccess	getCollectionDataAccess(NavigableRole collectionRole) Build a CollectionRegionAccess instance representing access to collection data stored in this cache region using the given AccessType.
CacheKeysFactory	getEffectiveKeysFactory()
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.
SessionFactoryImplementor	getSessionFactory()
protected void	releaseDataAccess(CollectionDataAccess cacheAccess)
protected void	releaseDataAccess(EntityDataAccess cacheAccess)
protected void	releaseDataAccess(NaturalIdDataAccess cacheAccess)

Methods inherited from class org.hibernate.cache.spi.support.AbstractRegion

getName, getRegionFactory

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

getName, getRegionFactory

Constructor Detail

AbstractDomainDataRegion

public AbstractDomainDataRegion(DomainDataRegionConfig regionConfig,
                                RegionFactory regionFactory,
                                CacheKeysFactory defaultKeysFactory,
                                DomainDataRegionBuildingContext buildingContext)

Method Detail

completeInstantiation

protected void completeInstantiation(DomainDataRegionConfig regionConfig,
                                     DomainDataRegionBuildingContext buildingContext)

Should be called at the end of the subtype's constructor, or at least after the `#super(...)` (aka, this type's constructor) call. It's a timing issue - we need access to the DomainDataStorageAccess in DomainDataRegionTemplate but in methods initiated (atm) from AbstractDomainDataRegion's constructor

getSessionFactory

public SessionFactoryImplementor getSessionFactory()

getEffectiveKeysFactory

public CacheKeysFactory getEffectiveKeysFactory()

getEntityDataAccess

public EntityDataAccess getEntityDataAccess(NavigableRole rootEntityRole)

Description copied from interface: DomainDataRegion

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

Specified by:

getEntityDataAccess in interface DomainDataRegion

Parameters:

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

getNaturalIdDataAccess

public NaturalIdDataAccess getNaturalIdDataAccess(NavigableRole rootEntityRole)

Description copied from interface: DomainDataRegion

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

Specified by:

getNaturalIdDataAccess in interface DomainDataRegion

Parameters:

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

getCollectionDataAccess

public CollectionDataAccess getCollectionDataAccess(NavigableRole collectionRole)

Description copied from interface: DomainDataRegion

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

Specified by:

getCollectionDataAccess in interface DomainDataRegion

Parameters:

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

generateEntityAccess

protected abstract EntityDataAccess generateEntityAccess(EntityDataCachingConfig entityAccessConfig)

generateCollectionAccess

protected abstract CollectionDataAccess generateCollectionAccess(CollectionDataCachingConfig cachingConfig)

generateNaturalIdAccess

protected abstract NaturalIdDataAccess generateNaturalIdAccess(NaturalIdDataCachingConfig naturalIdAccessConfig)

clear

public void clear()

Description copied from interface: Region

Clear all data cached in the region

Specified by:

clear in interface Region

releaseDataAccess

protected void releaseDataAccess(EntityDataAccess cacheAccess)

releaseDataAccess

protected void releaseDataAccess(NaturalIdDataAccess cacheAccess)

releaseDataAccess

protected void releaseDataAccess(CollectionDataAccess cacheAccess)

destroy

public void destroy()
             throws CacheException

Description copied from interface: Region

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

Specified by:

destroy in interface Region

Throws:

CacheException - Indicates problem shutting down