Package psidev.psi.mi.jami.bridges.uniprot

Class CachedUniprotGeneFetcher

java.lang.Object

psidev.psi.mi.jami.bridges.uniprot.UniprotGeneFetcher

psidev.psi.mi.jami.bridges.uniprot.CachedUniprotGeneFetcher

All Implemented Interfaces:

CachedFetcher, GeneFetcher, InteractorFetcher<Gene>

public class CachedUniprotGeneFetcher
extends UniprotGeneFetcher
implements CachedFetcher

Created with IntelliJ IDEA.

Since:

14/05/13

Author:

Gabriel Aldam (galdam@ebi.ac.uk)

Field Summary

Fields

Modifier and Type	Field	Description
static String	CACHE_NAME	Constant CACHE_NAME="uniprot-gene-service-cache"
static String	EHCACHE_CONFIG_FILE	Constant EHCACHE_CONFIG_FILE="/service.ehcache.xml"

Constructor Summary

Constructors

Constructor	Description
CachedUniprotGeneFetcher()	Constructor for CachedUniprotGeneFetcher.

Method Summary

Modifier and Type	Method	Description
void	clearCache()	clearCache.
Collection<Gene>	getByIdentifier(String identifier)	getByIdentifier.
Collection<Gene>	getByIdentifier(String identifier, int taxID)	getByIdentifier.
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 psidev.psi.mi.jami.bridges.uniprot.UniprotGeneFetcher

fetchByIdentifier, fetchByIdentifier, fetchByIdentifiers, fetchByIdentifiers

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

CACHE_NAME

public static final String CACHE_NAME

Constant CACHE_NAME="uniprot-gene-service-cache"

See Also:

Constant Field Values

Constructor Detail

CachedUniprotGeneFetcher

public CachedUniprotGeneFetcher()

Constructor for CachedUniprotGeneFetcher.

Method Detail

getByIdentifier

public Collection<Gene> getByIdentifier(String identifier)
                                 throws BridgeFailedException

getByIdentifier.

Parameters:

identifier - a String object.

Returns:

a Collection object.

Throws:

BridgeFailedException - if any.

getByIdentifier

public Collection<Gene> getByIdentifier(String identifier,
                                        int taxID)
                                 throws BridgeFailedException

getByIdentifier.

Parameters:

identifier - a String object.

taxID - a int.

Returns:

a Collection object.

Throws:

BridgeFailedException - if any.

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.

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

clearCache

public void clearCache()

clearCache.

Specified by:

clearCache in interface CachedFetcher

shutDownCache

public void shutDownCache()

shutDownCache.

Specified by:

shutDownCache in interface CachedFetcher