DelegatingDataCache (OpenJPA Parent POM 2.1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.openjpa.datacache
Class DelegatingDataCache

java.lang.Object
  org.apache.openjpa.datacache.DelegatingDataCache

All Implemented Interfaces:: DataCache, Clearable, Closeable

public class DelegatingDataCache
extends Object
implements DataCache
extends Object
implements DataCache

Delegating data cache that can also perform exception translation for use in facades. This cache allows its delegate to be null, in which case it returns default values for all operations.

Author:: Abe White

Field Summary

Fields inherited from interface org.apache.openjpa.datacache.DataCache
`NAME_DEFAULT`

Constructor Summary
`DelegatingDataCache(DataCache cache)` Constructor.
`DelegatingDataCache(DataCache cache, RuntimeExceptionTranslator trans)`

Method Summary
`void`	`addExpirationListener(ExpirationListener listen)` Add a new expiration event listener to this cache.
`void`	`clear()` Remove all data from this cache.
`void`	`close()` Free the resources used by this cache.
`void`	`commit(Collection<DataCachePCData> additions, Collection<DataCachePCData> newUpdates, Collection<DataCachePCData> existingUpdates, Collection<Object> deletes)` Perform a batch update of the cache.
`boolean`	`contains(Object oid)` Returns `true` if this cache contains data corresponding to `oid`; otherwise returns `false`.
`BitSet`	`containsAll(Collection<Object> oids)` Returns the indexes of the oids in this cache.
`boolean`	`equals(Object other)`
`DataCachePCData`	`get(Object oid)` Return the cached object for the given oid.
`Map<Object,DataCachePCData>`	`getAll(List<Object> keys)` Gets objects from the caches for a given list of keys.
`DataCache`	`getDelegate()` Return the direct delegate.
`boolean`	`getEvictOnBulkUpdate()` Returns whether the the cache needs to be updated when bulk updates as executed.
`DataCache`	`getInnermostDelegate()` Return the native delegate.
`String`	`getName()` Returns a string name that can be used by end-user-visible code to identify this cache.
`DataCache`	`getPartition(String name, boolean create)` Gets the named partition.
`Set<String>`	`getPartitionNames()` Gets the name of the known partitions.
`CacheStatistics`	`getStatistics()` Returns number of read/write request and cache hit ratio data.
`int`	`hashCode()`
`void`	`initialize(DataCacheManager manager)` Initialize any resources associated with the given `DataCacheManager`.
`boolean`	`isPartitioned()` Affirms if this cache maintains partitions.
`boolean`	`pin(Object oid)` Pin the value stored under `oid` into the cache.
`void`	`pinAll(Class<?> cls, boolean subs)` Pin all oids for the given type.
`BitSet`	`pinAll(Collection<Object> oids)` Pin all oids to the cache.
`DataCachePCData`	`put(DataCachePCData value)` Set the cached value for the given instance.
`DataCachePCData`	`remove(Object oid)` Remove the value stored under the given oid.
`void`	`removeAll(Class<?> cls, boolean subclasses)` Evict all values of a specified type.
`BitSet`	`removeAll(Collection<Object> oids)` Remove the values stored under the given oids.
`boolean`	`removeExpirationListener(ExpirationListener listen)` Remove an expiration event listener from this cache.
`void`	`setName(String name)` Sets a string name to be used to identify this cache to end-user needs.
`protected RuntimeException`	`translate(RuntimeException re)` Translate the OpenJPA exception.
`boolean`	`unpin(Object oid)` Unpin the value stored under `oid` from the cache.
`void`	`unpinAll(Class<?> cls, boolean subs)` Unpin all oids associaed with the given type from the cache.
`BitSet`	`unpinAll(Collection<Object> oids)` Unpin all oids from the cache.
`void`	`update(DataCachePCData value)` Update the cached value for the given instance.
`void`	`writeLock()` Obtain a write lock on the cache.
`void`	`writeUnlock()` Release the write lock on the cache.

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

Constructor Detail

DelegatingDataCache

public DelegatingDataCache(DataCache cache)

Constructor. Supply delegate.

DelegatingDataCache

public DelegatingDataCache(DataCache cache,
                           RuntimeExceptionTranslator trans)

Method Detail

getDelegate

public DataCache getDelegate()

Return the direct delegate.

getInnermostDelegate

public DataCache getInnermostDelegate()

Return the native delegate.

hashCode

public int hashCode()

Overrides:: hashCode in class Object

equals

public boolean equals(Object other)

Overrides:: equals in class Object

translate

protected RuntimeException translate(RuntimeException re)

Translate the OpenJPA exception.