CachedFetcher (PSI :: JAMI - Java framework for molecular interactions 3.3.0 API)

All Known Implementing Classes:

AbstractCachedFetcher, CachedChebiFetcher, CachedEuroPubmedCentralFetcher, CachedOlsCvTermFetcher, CachedOlsFetcher, CachedOlsOntologyTermFetcher, CachedOlsSourceFetcher, CachedUniprotGeneFetcher, CachedUniprotProteinFetcher, CachedUniprotTaxonomyFetcher, CachedUnisaveClient
```
public interface CachedFetcher
```
An interface defining the basic interaction with the cache.

Since:

08/07/13

Author:

Gabriel Aldam (galdam@ebi.ac.uk)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearCache()`	Clears the contents of the cache.
`Object`	`getFromCache(String key)`	Fetch an element from the cache with a given key
`void`	`initialiseCache()`	Initialises the cache with default settings.
`void`	`initialiseCache(String settingsFile)`	Initialises the cache with the settings in the file at the location.
`void`	`shutDownCache()`	Shuts the cache down.
`void`	`storeInCache(String key, Object data)`	Stores a given object in the cache with a key

- Method Detail
  - initialiseCache
```
void initialiseCache()
```
    Initialises the cache with default settings.
  - initialiseCache
```
void initialiseCache(String settingsFile)
```
    Initialises the cache with the settings in the file at the location.
    
    Parameters:
    
    settingsFile - The path of a file with the settings for an EHCache
  - clearCache
```
void clearCache()
```
    Clears the contents of the cache.
  - shutDownCache
```
void shutDownCache()
```
    Shuts the cache down.
  - getFromCache
```
Object getFromCache(String key)
```
    Fetch an element from the cache with a given key
    
    Parameters:
    
    key - a String object.
    
    Returns:
    
    a Object object.
  - storeInCache
```
void storeInCache(String key,
                  Object data)
```
    Stores a given object in the cache with a key
    
    Parameters:
    
    key - a String object.
    
    data - a Object object.