com.googlecode.n_orm.cache.read

Class CachedStore

java.lang.Object

com.googlecode.n_orm.storeapi.DelegatingStore

com.googlecode.n_orm.cache.read.CachedStore

All Implemented Interfaces:

Store

public class CachedStore
extends DelegatingStore

Constructor Summary

Constructors

Constructor and Description
CachedStore(Store actualStore) {createCache() must be overridden to use this constructor.
CachedStore(Store actualStore, ICache cache)

Method Summary

Modifier and Type	Method and Description
protected ICache	createCache() Called at store {startup when constructor {CachedStore(Store) was invoked.
void	delete(MetaInformation meta, String table, String id) Deletes a particular element.
boolean	exists(MetaInformation meta, String table, String row) Tests for a row.
boolean	exists(MetaInformation meta, String table, String row, String family) check if an element exist in the cache
Row.ColumnFamilyData	get(MetaInformation meta, String table, String id, Set<String> families) Returns all elements in families ; no side-effect.
Map<String,byte[]>	get(MetaInformation meta, String table, String id, String family) Returns all elements in a family ; no side-effect.
ICache	getCache() The actual cache used
boolean	isEnabledByDefault() Whether read cache is enabled by default for thread that did not call setEnabledForCurrentThread(boolean).
static boolean	isEnabledForCurrentThread() Whether read cache should be enabled for this thread even for de-activated read cache stores.
void	setEnabledByDefault(boolean enabled) Whether read cache is enabled by default for thread that did not call setEnabledForCurrentThread(boolean).
static void	setEnabledForCurrentThread(boolean enabled) Whether cache should be enabled for this thread even for de-activated write-retention stores.
void	start() Called once the store is created ; only one store is instanciated with the same properties.

Methods inherited from class com.googlecode.n_orm.storeapi.DelegatingStore

count, get, get, get, getActualStore, getActualStore, getDeepActualStore, hasTable, storeChanges

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CachedStore

public CachedStore(Store actualStore)

{createCache() must be overridden to use this constructor.

Parameters:

actualStore -

CachedStore

public CachedStore(Store actualStore,
                   ICache cache)

Method Detail

isEnabledForCurrentThread

public static boolean isEnabledForCurrentThread()

Whether read cache should be enabled for this thread even for de-activated read cache stores.

setEnabledForCurrentThread

public static void setEnabledForCurrentThread(boolean enabled)

Whether cache should be enabled for this thread even for de-activated write-retention stores.

getCache

public ICache getCache()

The actual cache used

createCache

protected ICache createCache()

Called at store {startup when constructor {CachedStore(Store) was invoked. Does not need to be thread safe.

Returns:

the cache to be used.

start

public void start()
           throws DatabaseNotReachedException

Description copied from interface: Store

Called once the store is created ; only one store is instanciated with the same properties.

Specified by:

start in interface Store

Overrides:

start in class DelegatingStore

Throws:

DatabaseNotReachedException

isEnabledByDefault

public boolean isEnabledByDefault()

Whether read cache is enabled by default for thread that did not call setEnabledForCurrentThread(boolean).

setEnabledByDefault

public void setEnabledByDefault(boolean enabled)

Whether read cache is enabled by default for thread that did not call setEnabledForCurrentThread(boolean).

delete

public void delete(MetaInformation meta,
                   String table,
                   String id)
            throws DatabaseNotReachedException

Description copied from interface: Store

Deletes a particular element.

Specified by:

delete in interface Store

Overrides:

delete in class DelegatingStore

Throws:

DatabaseNotReachedException

exists

public boolean exists(MetaInformation meta,
                      String table,
                      String row,
                      String family)
               throws DatabaseNotReachedException

check if an element exist in the cache

Specified by:

exists in interface Store

Overrides:

exists in class DelegatingStore

Throws:

DatabaseNotReachedException

get

public Map<String,byte[]> get(MetaInformation meta,
                              String table,
                              String id,
                              String family)
                       throws DatabaseNotReachedException

Description copied from interface: Store

Returns all elements in a family ; no side-effect. In case one element is missing, null is returned.

Specified by:

get in interface Store

Overrides:

get in class DelegatingStore

Throws:

DatabaseNotReachedException

exists

public boolean exists(MetaInformation meta,
                      String table,
                      String row)
               throws DatabaseNotReachedException

Description copied from interface: Store

Tests for a row.

Specified by:

exists in interface Store

Overrides:

exists in class DelegatingStore

Throws:

DatabaseNotReachedException

get

public Row.ColumnFamilyData get(MetaInformation meta,
                                String table,
                                String id,
                                Set<String> families)
                         throws DatabaseNotReachedException

Description copied from interface: Store

Returns all elements in families ; no side-effect. In case element with the given key is missing, null is returned.

Specified by:

get in interface Store

Overrides:

get in class DelegatingStore

table - the table from which to find the element

id - the unique identifier (i.e. the key) with which the element was stored

families - the set of column families to be activated ; should never be null or empty

Returns:

the data stored for each family ; null if and only if the id does not exist within the given table

Throws:

DatabaseNotReachedException