Package uk.gov.gchq.gaffer.federatedstore

Class FederatedStoreCache

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.FederatedStoreCache

public final class FederatedStoreCache
extends Object

Wrapper around FederatedStoreCacheTransient to provide an interface for handling Graphs within a FederatedStore.

Constructor Summary

Constructors

Constructor	Description
FederatedStoreCache(String suffixFederatedStoreCacheName)

Method Summary

Modifier and Type	Method	Description
void	addGraphToCache(Graph graph, FederatedAccess access, boolean overwrite)	Add the specified Graph to the cache.
void	addGraphToCache(GraphSerialisable graphSerialisable, byte[] access, boolean overwrite)
void	addGraphToCache(GraphSerialisable graphSerialisable, FederatedAccess access, boolean overwrite)	Add the specified Graph to the cache.
void	clearCache()
boolean	contains(String graphId)
void	deleteFromCache(String key)
void	deleteGraphFromCache(String graphId)
FederatedAccess	getAccessFromCache(String graphId)
Iterable<String>	getAllGraphIds()	Get all the ID's related to the Graph's stored in the cache.
Iterable<String>	getAllKeys()
ICache	getCache()
String	getCacheName()
static String	getCacheNameFrom(String suffixCacheName)
Pair<GraphSerialisable,FederatedAccess>	getFromCache(String key)
GraphSerialisable	getGraphFromCache(String graphId)	Retrieve the GraphSerialisable with the specified ID from the cache.
GraphSerialisable	getGraphSerialisableFromCache(String graphId)	Retrieve the Graph with the specified ID from the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

FederatedStoreCache

public FederatedStoreCache(String suffixFederatedStoreCacheName)

Method Detail

getAllGraphIds

public Iterable<String> getAllGraphIds()

Get all the ID's related to the Graph's stored in the cache.

Returns:

all the Graph ID's within the cache.

addGraphToCache

public void addGraphToCache(Graph graph,
                            FederatedAccess access,
                            boolean overwrite)
                     throws CacheOperationException

Add the specified Graph to the cache.

Parameters:

graph - the Graph to be added

overwrite - if true, overwrite any graphs already in the cache with the same ID

access - Access for the graph being stored.

Throws:

CacheOperationException - if issues adding to cache

addGraphToCache

public void addGraphToCache(GraphSerialisable graphSerialisable,
                            FederatedAccess access,
                            boolean overwrite)
                     throws CacheOperationException

Add the specified Graph to the cache.

Parameters:

graphSerialisable - the serialised Graph to be added

access - Access for the graph being stored.

overwrite - if true, overwrite any graphs already in the cache with the same ID

Throws:

CacheOperationException - if issues adding to cache

deleteGraphFromCache

public void deleteGraphFromCache(String graphId)

getGraphFromCache

public GraphSerialisable getGraphFromCache(String graphId)
                                    throws CacheOperationException

Retrieve the GraphSerialisable with the specified ID from the cache.

Parameters:

graphId - the ID of the Graph to retrieve

Returns:

the GraphSerialisable related to the specified ID

Throws:

CacheOperationException - exception

getGraphSerialisableFromCache

public GraphSerialisable getGraphSerialisableFromCache(String graphId)

Retrieve the Graph with the specified ID from the cache.

Parameters:

graphId - the ID of the Graph to retrieve

Returns:

the Graph related to the specified ID

addGraphToCache

public void addGraphToCache(GraphSerialisable graphSerialisable,
                            byte[] access,
                            boolean overwrite)
                     throws CacheOperationException

Throws:

CacheOperationException

getAccessFromCache

public FederatedAccess getAccessFromCache(String graphId)

getFromCache

public Pair<GraphSerialisable,FederatedAccess> getFromCache(String key)

getCacheName

public String getCacheName()

getAllKeys

public Iterable<String> getAllKeys()

clearCache

public void clearCache()
                throws CacheOperationException

Throws:

CacheOperationException

contains

public boolean contains(String graphId)

deleteFromCache

public void deleteFromCache(String key)

getCache

public ICache getCache()

getCacheNameFrom

public static String getCacheNameFrom(String suffixCacheName)