org.apache.oodt.cas.filemgr.ingest

Interface Cache

All Known Implementing Classes:

LocalCache, RmiCache

public interface Cache

Version:

$Revision$

The core interface for a cache of Products (identified by a particular uniqueElement) from a File Manager.

.

Author:

mattmann, bfoster

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_UNIQUE_MET_KEY

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the current cache.
boolean	contains(String productName) Checks the cache to determine if a Product with the given productName exists.
URL	getFileManagerUrl() Gets the URL of the File Manager that this Cache communicates with.
void	setFileManager(URL fmUrl) Specifies the URL to the File Manager to connect this Cache to.
void	setUniqueElementName(String uniqueElementName) Sets the name of the met element to use as the identifier of a Product for use in determining whether the Product is in the Cache.
void	setUniqueElementProductTypeNames(List<String> uniqueElementProductTypeNames) Sets the names of the ProductTypes to cache.
int	size()
void	sync() Synchronizes this Cache with the File Manager specified by the setFileManager(URL) method.
void	sync(List<String> uniqueElementProductTypeNames) Synchronizes this Cache with the File Manager specified by the setFileManager(URL) method.
void	sync(String uniqueElementName, List<String> uniqueElementProductTypeNames) Synchronizes this Cache with the File Manager specified by the setFileManager(URL) method.

Field Detail

DEFAULT_UNIQUE_MET_KEY

static final String DEFAULT_UNIQUE_MET_KEY

See Also:

Constant Field Values

Method Detail

clear

void clear()

Clears the current cache. This should be used before a re-#sync(String, String)) occurs.

contains

boolean contains(String productName)

Checks the cache to determine if a Product with the given productName exists.

Parameters:

productName - The name of the Product to check for in the Cache.

Returns:

True if the Product is foudn in the Cache, False, otherwise.

setFileManager

void setFileManager(URL fmUrl)

Specifies the URL to the File Manager to connect this Cache to.

Parameters:

fmUrl - The URL of the File Manager to cache Products from.

size

int size()

Returns:

The size of the current Product cache.

sync

void sync(List<String> uniqueElementProductTypeNames)
          throws CacheException

Synchronizes this Cache with the File Manager specified by the setFileManager(URL) method.

Parameters:

uniqueElementProductTypeNames - The List ProductTypes to cache Products from.

Throws:

CacheException - If there is any error.

sync

void sync(String uniqueElementName,
        List<String> uniqueElementProductTypeNames)
          throws CacheException

Synchronizes this Cache with the File Manager specified by the setFileManager(URL) method.

Parameters:

uniqueElementName - The met key identifier to use for determining Product existance (if different than "CAS.ProductName").

uniqueElementProductTypeNames - The List of ProductTypes to cache Products from.

Throws:

CacheException - If there is any error.

sync

void sync()
          throws CacheException

Synchronizes this Cache with the File Manager specified by the setFileManager(URL) method. This method also assumes that the unique element (identified by setUniqueElementName(String) and the List of ProductTypes have also been set appropriate (e.g., by using setUniqueElementProductTypeNames(List).

Throws:

CacheException - If any error occurs.

setUniqueElementProductTypeNames

void setUniqueElementProductTypeNames(List<String> uniqueElementProductTypeNames)

Sets the names of the ProductTypes to cache.

Parameters:

uniqueElementProductTypeNames - A List of java.util.String names of ProductTypes.

setUniqueElementName

void setUniqueElementName(String uniqueElementName)

Sets the name of the met element to use as the identifier of a Product for use in determining whether the Product is in the Cache.

Parameters:

uniqueElementName - The name of the met element used to uniquely identify Products.

getFileManagerUrl

URL getFileManagerUrl()

Gets the URL of the File Manager that this Cache communicates with.

Returns:

The URL of the File Manager that this Cache communicates with.