Package psidev.psi.mi.jami.bridges.fetcher

Class AbstractCachedFetcher

java.lang.Object

psidev.psi.mi.jami.bridges.fetcher.AbstractCachedFetcher

All Implemented Interfaces:

CachedFetcher

Direct Known Subclasses:

CachedChebiFetcher, CachedEuroPubmedCentralFetcher, CachedOlsFetcher, CachedUniprotProteinFetcher, CachedUniprotTaxonomyFetcher, CachedUnisaveClient

public abstract class AbstractCachedFetcher
extends Object
implements CachedFetcher

Abstract class for fetchers

Since:

09/09/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Field Summary

Fields

Modifier and Type	Field	Description
static String	EHCACHE_CONFIG_FILE	Constant EHCACHE_CONFIG_FILE="/service.ehcache.xml"

Constructor Summary

Constructors

Constructor	Description
AbstractCachedFetcher(String cacheName)	Constructor for AbstractCachedFetcher.

Method Summary

Modifier and Type	Method	Description
void	clearCache()	clearCache.
Object	getFromCache(String key)	Fetch an element from the cache with a given key
void	initialiseCache()	initialiseCache.
void	initialiseCache(String settingsFile)	Initialises the cache with the settings in the file at the location.
void	shutDownCache()	shutDownCache.
void	storeInCache(String key, Object data)	Stores a given object in the cache with a key

Methods inherited from class java.lang.Object

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

Field Detail

EHCACHE_CONFIG_FILE

public static final String EHCACHE_CONFIG_FILE

Constant EHCACHE_CONFIG_FILE="/service.ehcache.xml"

See Also:

Constant Field Values

Constructor Detail

AbstractCachedFetcher

public AbstractCachedFetcher(String cacheName)

Constructor for AbstractCachedFetcher.

Parameters:

cacheName - a String object.

Method Detail

initialiseCache

public void initialiseCache()

initialiseCache.

Specified by:

initialiseCache in interface CachedFetcher

initialiseCache

public void initialiseCache(String settingsFile)

Initialises the cache with the settings in the file at the location.

Specified by:

initialiseCache in interface CachedFetcher

Parameters:

settingsFile - The path of a file with the settings for an EHCache

getFromCache

public Object getFromCache(String key)

Fetch an element from the cache with a given key

Specified by:

getFromCache in interface CachedFetcher

Parameters:

key - a String object.

Returns:

a Object object.

storeInCache

public void storeInCache(String key,
                         Object data)

Stores a given object in the cache with a key

Specified by:

storeInCache in interface CachedFetcher

Parameters:

key - a String object.

data - a Object object.

clearCache

public void clearCache()

clearCache.

Specified by:

clearCache in interface CachedFetcher

shutDownCache

public void shutDownCache()

shutDownCache.

Specified by:

shutDownCache in interface CachedFetcher