javax.jdo.datastore

Interface DataStoreCache

Known Implementing Classes:
DataStoreCache.EmptyDataStoreCache

public interface DataStoreCache

Many JDO implementations allow instances to be cached in a second-level cache, and allow direct management of the cache by knowledgeable applications. This interface standardizes this behavior.
Version:
2.0
Since:
2.0

Nested Class Summary

class
DataStoreCache.EmptyDataStoreCache
This class is an empty implementation of the DataStoreCache interface.

Method Summary

void
evict(Object oid)
Evict the parameter instance from the second-level cache.
void
evictAll()
Evict the parameter instances from the second-level cache.
void
evictAll(Class pcClass, boolean subclasses)
Evict the parameter instances from the second-level cache.
void
evictAll(Collection oids)
Evict the parameter instances from the second-level cache.
void
evictAll(Object[] oids)
Evict the parameter instances from the second-level cache.
void
pin(Object oid)
Pin the parameter instance in the second-level cache.
void
pinAll(Class pcClass, boolean subclasses)
Pin instances in the second-level cache.
void
pinAll(Collection oids)
Pin the parameter instances in the second-level cache.
void
pinAll(Object[] oids)
Pin the parameter instances in the second-level cache.
void
unpin(Object oid)
Unpin the parameter instance from the second-level cache.
void
unpinAll(Class pcClass, boolean subclasses)
Unpin instances from the second-level cache.
void
unpinAll(Collection oids)
Unpin the parameter instances from the second-level cache.
void
unpinAll(Object[] oids)
Unpin the parameter instance from the second-level cache.

Method Details

evict

public void evict(Object oid)
Evict the parameter instance from the second-level cache.
Parameters:
oid - the object id of the instance to evict.
Since:
2.0

evictAll

public void evictAll()
Evict the parameter instances from the second-level cache. All instances in the PersistenceManager's cache are evicted from the second-level cache.
Since:
2.0

evictAll

public void evictAll(Class pcClass,
                     boolean subclasses)
Evict the parameter instances from the second-level cache.
Parameters:
pcClass - the class of instances to evict
subclasses - if true, evict instances of subclasses also
Since:
2.0

evictAll

public void evictAll(Collection oids)
Evict the parameter instances from the second-level cache.
Parameters:
oids - the object ids of the instance to evict.
Since:
2.0

evictAll

public void evictAll(Object[] oids)
Evict the parameter instances from the second-level cache.
Parameters:
oids - the object ids of the instance to evict.
Since:
2.0

pin

public void pin(Object oid)
Pin the parameter instance in the second-level cache.
Parameters:
oid - the object id of the instance to pin.
Since:
2.0

pinAll

public void pinAll(Class pcClass,
                   boolean subclasses)
Pin instances in the second-level cache.
Parameters:
pcClass - the class of instances to pin
subclasses - if true, pin instances of subclasses also
Since:
2.0

pinAll

public void pinAll(Collection oids)
Pin the parameter instances in the second-level cache.
Parameters:
oids - the object ids of the instances to pin.
Since:
2.0

pinAll

public void pinAll(Object[] oids)
Pin the parameter instances in the second-level cache.
Parameters:
oids - the object ids of the instances to pin.
Since:
2.0

unpin

public void unpin(Object oid)
Unpin the parameter instance from the second-level cache.
Parameters:
oid - the object id of the instance to unpin.
Since:
2.0

unpinAll

public void unpinAll(Class pcClass,
                     boolean subclasses)
Unpin instances from the second-level cache.
Parameters:
pcClass - the class of instances to unpin
subclasses - if true, unpin instances of subclasses also
Since:
2.0

unpinAll

public void unpinAll(Collection oids)
Unpin the parameter instances from the second-level cache.
Parameters:
oids - the object ids of the instance to evict.
Since:
2.0

unpinAll

public void unpinAll(Object[] oids)
Unpin the parameter instance from the second-level cache.
Parameters:
oids - the object id of the instance to evict.
Since:
2.0