omero.gateway.cache

Interface CacheService

public interface CacheService

Defines the caching service interface.

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Field Summary

Fields

Modifier and Type	Field and Description
static int	CACHE_SIZE The default size of a cache.
static int	DEFAULT Indicates to create a default cache.
static int	IN_MEMORY Indicates to cache data in memory only.
static int	PERSISTENCE_ON_DISK Indicates to cache data on disk.

Method Summary

Modifier and Type	Method and Description
void	addElement(int cacheID, Object key, Object element) Adds the specified element to the selected cache.
void	clearAllCaches() Clears all the caches.
void	clearCache(int cacheID) Clears the specified cache.
int	createCache() Creates a default cache.
int	createCache(int type) Creates a cache of a given type.
int	createCache(int type, int size) Creates a cache of a given type.
Object	getElement(int cacheID, Object key) Adds the specified element to the selected cache.
void	removeCache(int cacheID) Removes the cache corresponding to the passed id.
void	setCacheEntries(int cacheID, int entries) Resets the number of items in memory of the cache, when a new cache is created or deleted.
void	shutDown() Shuts the cache down.

Field Detail

DEFAULT

static final int DEFAULT

Indicates to create a default cache.

See Also:

Constant Field Values

PERSISTENCE_ON_DISK

static final int PERSISTENCE_ON_DISK

Indicates to cache data on disk.

See Also:

Constant Field Values

IN_MEMORY

static final int IN_MEMORY

Indicates to cache data in memory only.

See Also:

Constant Field Values

CACHE_SIZE

static final int CACHE_SIZE

The default size of a cache.

See Also:

Constant Field Values

Method Detail

createCache

int createCache()

Creates a default cache.

Returns:

See above.

createCache

int createCache(int type,
                int size)

Creates a cache of a given type.

Parameters:

type - The type of cache to create.

size - The size of the cache.

Returns:

See above.

createCache

int createCache(int type)

Creates a cache of a given type.

Parameters:

type - The type of cache to create.

Returns:

See above.

removeCache

void removeCache(int cacheID)

Removes the cache corresponding to the passed id.

Parameters:

cacheID - The id of the cache.

addElement

void addElement(int cacheID,
                Object key,
                Object element)

Adds the specified element to the selected cache.

Parameters:

cacheID - The id of the cache.

key - The key corresponding to the element to add.

element - The element to add.

getElement

Object getElement(int cacheID,
                  Object key)

Adds the specified element to the selected cache.

Parameters:

cacheID - The id of the cache.

key - The key corresponding to the element to add.

Returns:

See above.

clearCache

void clearCache(int cacheID)

Clears the specified cache.

Parameters:

cacheID - The id of the cache to clear.

setCacheEntries

void setCacheEntries(int cacheID,
                     int entries)

Resets the number of items in memory of the cache, when a new cache is created or deleted.

Parameters:

cacheID - The id of the cache.

entries - The number of entries.

clearAllCaches

void clearAllCaches()

Clears all the caches.

shutDown

void shutDown()

Shuts the cache down.