CacheImpl (Hibernate JavaDocs)

java.lang.Object
- org.hibernate.internal.CacheImpl

All Implemented Interfaces:

java.io.Serializable, javax.persistence.Cache, CacheImplementor, Service
```
public class CacheImpl
extends java.lang.Object
implements CacheImplementor
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CacheImpl(SessionFactoryImplementor sessionFactory)

Constructors
Constructor and Description
`CacheImpl(SessionFactoryImplementor sessionFactory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close all cache regions.
`boolean`	`contains(java.lang.Class cls, java.lang.Object primaryKey)`
`boolean`	`containsCollection(java.lang.String role, java.io.Serializable ownerIdentifier)` Determine whether the cache contains data for the given collection.
`boolean`	`containsEntity(java.lang.Class entityClass, java.io.Serializable identifier)` Determine whether the cache contains data for the given entity "instance".
`boolean`	`containsEntity(java.lang.String entityName, java.io.Serializable identifier)` Determine whether the cache contains data for the given entity "instance".
`boolean`	`containsQuery(java.lang.String regionName)` Determine whether the cache contains data for the given query.
`CollectionRegionAccessStrategy`	`determineCollectionRegionAccessStrategy(Collection model)`
`EntityRegionAccessStrategy`	`determineEntityRegionAccessStrategy(PersistentClass model)`
`NaturalIdRegionAccessStrategy`	`determineNaturalIdRegionAccessStrategy(PersistentClass model)`
`void`	`evict(java.lang.Class cls)`
`void`	`evict(java.lang.Class cls, java.lang.Object primaryKey)`
`void`	`evictAll()`
`void`	`evictAllRegions()` Evict all data from the cache.
`void`	`evictCollection(java.lang.String role, java.io.Serializable ownerIdentifier)` Evicts the cache data for the given identified collection instance.
`void`	`evictCollectionRegion(java.lang.String role)` Evicts all entity data from the given region (i.e.
`void`	`evictCollectionRegions()` Evict data from all collection regions.
`void`	`evictDefaultQueryRegion()` Evicts all cached query results from the default region.
`void`	`evictEntity(java.lang.Class entityClass, java.io.Serializable identifier)` Evicts the entity data for a particular entity "instance".
`void`	`evictEntity(java.lang.String entityName, java.io.Serializable identifier)` Evicts the entity data for a particular entity "instance".
`void`	`evictEntityRegion(java.lang.Class entityClass)` Evicts all entity data from the given region (i.e.
`void`	`evictEntityRegion(java.lang.String entityName)` Evicts all entity data from the given region (i.e.
`void`	`evictEntityRegions()` Evict data from all entity regions.
`void`	`evictNaturalIdRegion(java.lang.Class entityClass)` Evicts all naturalId data from the given region (i.e.
`void`	`evictNaturalIdRegion(java.lang.String entityName)` Evicts all naturalId data from the given region (i.e.
`void`	`evictNaturalIdRegions()` Evict data from all naturalId regions.
`void`	`evictQueries()` Clean up the default `QueryCache`.
`void`	`evictQueryRegion(java.lang.String regionName)` Evicts all cached query results under the given name.
`void`	`evictQueryRegions()` Evict data from all query regions.
`CollectionRegionAccessStrategy`	`getCollectionRegionAccess(java.lang.String regionName)` Find the "access strategy" for the named collection cache region.
`QueryCache`	`getDefaultQueryCache()` Get the default `QueryCache`.
`EntityRegionAccessStrategy`	`getEntityRegionAccess(java.lang.String regionName)` Find the "access strategy" for the named entity cache region.
`NaturalIdRegionAccessStrategy`	`getNaturalIdCacheRegionAccessStrategy(java.lang.String regionName)` Find the "access strategy" for the named natrual-id cache region.
`QueryCache`	`getQueryCache(java.lang.String regionName)` Get query cache by `region name` or create a new one if none exist.
`RegionFactory`	`getRegionFactory()` The underlying RegionFactory in use.
`java.lang.String[]`	`getSecondLevelCacheRegionNames()` Get the names of `all` cache regions, including entity, collection, natural-id and query caches.
`SessionFactory`	`getSessionFactory()` Access to the SessionFactory this Cache is bound to.
`UpdateTimestampsCache`	`getUpdateTimestampsCache()` Get `UpdateTimestampsCache` instance managed by the `SessionFactory`.
`java.lang.String`	`qualifyRegionName(java.lang.String regionName)` Applies any defined prefix, handling all `null` checks.
`<T> T`	`unwrap(java.lang.Class<T> cls)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.engine.spi.CacheImplementor
getQueryCache

- Constructor Detail
  - CacheImpl
```
public CacheImpl(SessionFactoryImplementor sessionFactory)
```
- Method Detail
  - getSessionFactory
```
public SessionFactory getSessionFactory()
```
    Description copied from interface: Cache
    
    Access to the SessionFactory this Cache is bound to.
    
    Returns:
    
    The SessionFactory
  - getRegionFactory
```
public RegionFactory getRegionFactory()
```
    Description copied from interface: CacheImplementor
    
    The underlying RegionFactory in use.
    
    Specified by:
    
    getRegionFactory in interface CacheImplementor
    
    Returns:
    
    The RegionFactory
  - qualifyRegionName
```
public java.lang.String qualifyRegionName(java.lang.String regionName)
```
    Description copied from interface: CacheImplementor
    
    Applies any defined prefix, handling all null checks.
    
    Specified by:
    
    qualifyRegionName in interface CacheImplementor
    
    Parameters:
    
    regionName - The region name to qualify
    
    Returns:
    
    The qualified name
  - containsEntity
```
public boolean containsEntity(java.lang.Class entityClass,
                              java.io.Serializable identifier)
```
    Description copied from interface: Cache
    
    Determine whether the cache contains data for the given entity "instance".
    The semantic here is whether the cache contains data visible for the current call context.
    
    Parameters:
    
    entityClass - The entity class.
    
    identifier - The entity identifier
    
    Returns:
    
    True if the underlying cache contains corresponding data; false otherwise.
  - containsEntity
```
public boolean containsEntity(java.lang.String entityName,
                              java.io.Serializable identifier)
```
    Description copied from interface: Cache
    
    Determine whether the cache contains data for the given entity "instance".
    The semantic here is whether the cache contains data visible for the current call context.
    
    Parameters:
    
    entityName - The entity name.
    
    identifier - The entity identifier
    
    Returns:
    
    True if the underlying cache contains corresponding data; false otherwise.
  - evictEntity
```
public void evictEntity(java.lang.Class entityClass,
                        java.io.Serializable identifier)
```
    Description copied from interface: Cache
    
    Evicts the entity data for a particular entity "instance".
    
    Parameters:
    
    entityClass - The entity class.
    
    identifier - The entity identifier
  - evictEntity
```
public void evictEntity(java.lang.String entityName,
                        java.io.Serializable identifier)
```
    Description copied from interface: Cache
    
    Evicts the entity data for a particular entity "instance".
    
    Parameters:
    
    entityName - The entity name.
    
    identifier - The entity identifier
  - evictEntityRegion
```
public void evictEntityRegion(java.lang.Class entityClass)
```
    Description copied from interface: Cache
    
    Evicts all entity data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityClass - The entity class.
  - evictEntityRegion
```
public void evictEntityRegion(java.lang.String entityName)
```
    Description copied from interface: Cache
    
    Evicts all entity data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityName - The entity name.
  - evictEntityRegions
```
public void evictEntityRegions()
```
    Description copied from interface: Cache
    
    Evict data from all entity regions.
  - evictNaturalIdRegion
```
public void evictNaturalIdRegion(java.lang.Class entityClass)
```
    Description copied from interface: Cache
    
    Evicts all naturalId data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityClass - The naturalId class.
  - evictNaturalIdRegion
```
public void evictNaturalIdRegion(java.lang.String entityName)
```
    Description copied from interface: Cache
    
    Evicts all naturalId data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityName - The naturalId name.
  - evictNaturalIdRegions
```
public void evictNaturalIdRegions()
```
    Description copied from interface: Cache
    
    Evict data from all naturalId regions.
  - containsCollection
```
public boolean containsCollection(java.lang.String role,
                                  java.io.Serializable ownerIdentifier)
```
    Description copied from interface: Cache
    
    Determine whether the cache contains data for the given collection.
    The semantic here is whether the cache contains data visible for the current call context.
    
    Parameters:
    
    role - The name of the collection role (in form [owner-entity-name].[collection-property-name]) whose regions should be evicted.
    
    ownerIdentifier - The identifier of the owning entity
    
    Returns:
    
    True if the underlying cache contains corresponding data; false otherwise.
  - evictCollection
```
public void evictCollection(java.lang.String role,
                            java.io.Serializable ownerIdentifier)
```
    Description copied from interface: Cache
    
    Evicts the cache data for the given identified collection instance.
    
    Parameters:
    
    role - The "collection role" (in form [owner-entity-name].[collection-property-name]).
    
    ownerIdentifier - The identifier of the owning entity
  - evictCollectionRegion
```
public void evictCollectionRegion(java.lang.String role)
```
    Description copied from interface: Cache
    
    Evicts all entity data from the given region (i.e. evicts cached data for all of the specified collection role).
    
    Parameters:
    
    role - The "collection role" (in form [owner-entity-name].[collection-property-name]).
  - evictCollectionRegions
```
public void evictCollectionRegions()
```
    Description copied from interface: Cache
    
    Evict data from all collection regions.
  - containsQuery
```
public boolean containsQuery(java.lang.String regionName)
```
    Description copied from interface: Cache
    
    Determine whether the cache contains data for the given query.
    The semantic here is whether the cache contains any data for the given region name since query result caches are not transactionally isolated.
    
    Parameters:
    
    regionName - The cache name given to the query.
    
    Returns:
    
    True if the underlying cache contains corresponding data; false otherwise.
  - evictDefaultQueryRegion
```
public void evictDefaultQueryRegion()
```
    Description copied from interface: Cache
    
    Evicts all cached query results from the default region.
  - evictQueryRegion
```
public void evictQueryRegion(java.lang.String regionName)
```
    Description copied from interface: Cache
    
    Evicts all cached query results under the given name.
    
    Parameters:
    
    regionName - The cache name associated to the queries being cached.
  - evictQueryRegions
```
public void evictQueryRegions()
```
    Description copied from interface: Cache
    
    Evict data from all query regions.
  - close
```
public void close()
```
    Description copied from interface: CacheImplementor
    
    Close all cache regions.
    
    Specified by:
    
    close in interface CacheImplementor
  - getDefaultQueryCache
```
public QueryCache getDefaultQueryCache()
```
    Description copied from interface: CacheImplementor
    
    Get the default QueryCache.
    
    Specified by:
    
    getDefaultQueryCache in interface CacheImplementor
  - getQueryCache
```
public QueryCache getQueryCache(java.lang.String regionName)
                         throws HibernateException
```
    Description copied from interface: CacheImplementor
    
    Get query cache by region name or create a new one if none exist.
    If the region name is null, then default query cache region will be returned.
    
    Specified by:
    
    getQueryCache in interface CacheImplementor
    
    Parameters:
    
    regionName - Query cache region name.
    
    Returns:
    
    The QueryCache associated with the region name, or default query cache if the region name is null.
    
    Throws:
    
    HibernateException - HibernateException maybe thrown when the creation of new QueryCache instance.
  - getUpdateTimestampsCache
```
public UpdateTimestampsCache getUpdateTimestampsCache()
```
    Description copied from interface: CacheImplementor
    
    Get UpdateTimestampsCache instance managed by the SessionFactory.
    
    Specified by:
    
    getUpdateTimestampsCache in interface CacheImplementor
  - evictQueries
```
public void evictQueries()
                  throws HibernateException
```
    Description copied from interface: CacheImplementor
    
    Clean up the default QueryCache.
    
    Specified by:
    
    evictQueries in interface CacheImplementor
    
    Throws:
    
    HibernateException
  - getSecondLevelCacheRegionNames
```
public java.lang.String[] getSecondLevelCacheRegionNames()
```
    Description copied from interface: CacheImplementor
    
    Get the names of all cache regions, including entity, collection, natural-id and query caches.
    
    Specified by:
    
    getSecondLevelCacheRegionNames in interface CacheImplementor
    
    Returns:
    
    All cache region names
  - getEntityRegionAccess
```
public EntityRegionAccessStrategy getEntityRegionAccess(java.lang.String regionName)
```
    Description copied from interface: CacheImplementor
    
    Find the "access strategy" for the named entity cache region.
    
    Specified by:
    
    getEntityRegionAccess in interface CacheImplementor
    
    Parameters:
    
    regionName - The name of the region
    
    Returns:
    
    That region's "access strategy"
  - getCollectionRegionAccess
```
public CollectionRegionAccessStrategy getCollectionRegionAccess(java.lang.String regionName)
```
    Description copied from interface: CacheImplementor
    
    Find the "access strategy" for the named collection cache region.
    
    Specified by:
    
    getCollectionRegionAccess in interface CacheImplementor
    
    Parameters:
    
    regionName - The name of the region
    
    Returns:
    
    That region's "access strategy"
  - getNaturalIdCacheRegionAccessStrategy
```
public NaturalIdRegionAccessStrategy getNaturalIdCacheRegionAccessStrategy(java.lang.String regionName)
```
    Description copied from interface: CacheImplementor
    
    Find the "access strategy" for the named natrual-id cache region.
    
    Specified by:
    
    getNaturalIdCacheRegionAccessStrategy in interface CacheImplementor
    
    Parameters:
    
    regionName - The name of the region
    
    Returns:
    
    That region's "access strategy"
  - evictAllRegions
```
public void evictAllRegions()
```
    Description copied from interface: Cache
    
    Evict all data from the cache.
  - contains
```
public boolean contains(java.lang.Class cls,
                        java.lang.Object primaryKey)
```
    Specified by:
    
    contains in interface javax.persistence.Cache
  - evict
```
public void evict(java.lang.Class cls,
                  java.lang.Object primaryKey)
```
    Specified by:
    
    evict in interface javax.persistence.Cache
  - evict
```
public void evict(java.lang.Class cls)
```
    Specified by:
    
    evict in interface javax.persistence.Cache
  - evictAll
```
public void evictAll()
```
    Specified by:
    
    evictAll in interface javax.persistence.Cache
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> cls)
```
    Specified by:
    
    unwrap in interface javax.persistence.Cache
  - determineEntityRegionAccessStrategy
```
public EntityRegionAccessStrategy determineEntityRegionAccessStrategy(PersistentClass model)
```
    Specified by:
    
    determineEntityRegionAccessStrategy in interface CacheImplementor
  - determineNaturalIdRegionAccessStrategy
```
public NaturalIdRegionAccessStrategy determineNaturalIdRegionAccessStrategy(PersistentClass model)
```
    Specified by:
    
    determineNaturalIdRegionAccessStrategy in interface CacheImplementor
  - determineCollectionRegionAccessStrategy
```
public CollectionRegionAccessStrategy determineCollectionRegionAccessStrategy(Collection model)
```
    Specified by:
    
    determineCollectionRegionAccessStrategy in interface CacheImplementor

Class CacheImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.engine.spi.CacheImplementor

Constructor Detail

CacheImpl

Method Detail

getSessionFactory

getRegionFactory

qualifyRegionName

containsEntity

containsEntity

evictEntity

evictEntity

evictEntityRegion

evictEntityRegion

evictEntityRegions

evictNaturalIdRegion

evictNaturalIdRegion

evictNaturalIdRegions

containsCollection

evictCollection

evictCollectionRegion

evictCollectionRegions

containsQuery

evictDefaultQueryRegion

evictQueryRegion

evictQueryRegions

close

getDefaultQueryCache

getQueryCache

getUpdateTimestampsCache

evictQueries

getSecondLevelCacheRegionNames

getEntityRegionAccess

getCollectionRegionAccess

getNaturalIdCacheRegionAccessStrategy

evictAllRegions

contains

evict

evict

evictAll

unwrap

determineEntityRegionAccessStrategy

determineNaturalIdRegionAccessStrategy

determineCollectionRegionAccessStrategy