org.kepler.objectmanager.cache

Class DataCacheFileObject

java.lang.Object

org.kepler.objectmanager.cache.CacheObject

org.kepler.objectmanager.cache.DataCacheObject

org.kepler.objectmanager.cache.DataCacheFileObject

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, CacheObjectInterface

public class DataCacheFileObject
extends DataCacheObject

This class is not as generic as the name may indicate. It is designed to get the metadata to determine where the data is stored and then does a Ecogrid "get" to the data.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	COPY_FILE_TO_CACHE
static int	EXTERNAL
static int	INTERNAL
protected int	mFileLoc
static int	UNKNOWN

Fields inherited from class org.kepler.objectmanager.cache.DataCacheObject

CACHE_BUSY, CACHE_COMPLETE, CACHE_EMPTY, CACHE_ERROR

Fields inherited from class org.kepler.objectmanager.cache.CacheObject

_attributes, _lsid, _name, _semanticTypes

Constructor Summary

Constructors

Constructor and Description
DataCacheFileObject() A DataCacheFileObject object that can point to an itnernal file or external file object

Method Summary

Modifier and Type	Method and Description
int	doWork() Abstract method for actually getting the data while in the thread
int	getFileLocation()
java.lang.String	getType()
void	initializeWithFileName(java.lang.String aPhysicalName, java.lang.String aLogicalName, java.lang.String aType, int aFileLocation) This is one of the hardest working methods in the class.
void	setFileLocation(int aFileLoc) Set the status of the file item

Methods inherited from class org.kepler.objectmanager.cache.DataCacheObject

addListener, clear, getAbsoluteFileName, getBaseFileName, getCreatedDate, getDataInputStream, getFile, getObject, getResourceName, getStatus, isBusy, isEmpty, isError, isReady, notifyListeners, refresh, removeAllListeners, removeListener, reset, run, setAbsoluteFileName, setBaseFileName, setCreatedDate, setResourceName, start, stop, toString

Methods inherited from class org.kepler.objectmanager.cache.CacheObject

addAttribute, getAttribute, getAttributeNames, getLSID, getName, getSemanticTypes, objectAdded, objectPurged, objectRemoved, removeAttribute, setLSID, setName, setSemanticTypes

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

INTERNAL

public static final int INTERNAL

See Also:

Constant Field Values

EXTERNAL

public static final int EXTERNAL

See Also:

Constant Field Values

COPY_FILE_TO_CACHE

public static final int COPY_FILE_TO_CACHE

See Also:

Constant Field Values

mFileLoc

protected int mFileLoc

Constructor Detail

DataCacheFileObject

public DataCacheFileObject()

A DataCacheFileObject object that can point to an itnernal file or external file object

Method Detail

getFileLocation

public int getFileLocation()

Returns:

Returns whether the file is internal or external, if nothing has happened then it return UNKNOWN

getType

public java.lang.String getType()

Returns:

Returns the string describing the files type

setFileLocation

public void setFileLocation(int aFileLoc)

Set the status of the file item

Parameters:

aFileLoc - the location type

initializeWithFileName

public void initializeWithFileName(java.lang.String aPhysicalName,
                                   java.lang.String aLogicalName,
                                   java.lang.String aType,
                                   int aFileLocation)

This is one of the hardest working methods in the class. It determines what to do the aFileName argument. If the file type is: INTENRAL then it creates a new "empty" file, and the aFileName is just text EXTERNAL then it uses aFileName as the mLocalFileName data member in order to point at the extneral file. NOTE: An extneral file is NEVER deleted by the DCM COPY_FILE_TO_CACHE then it copies the file from the extneral location identifed by the aFileName argument to an intneral cache file. Afterward it sets the mFileLoc to INTERNAL

Parameters:

aPhysicalFileName - the "physical" name of a file (this name will not be stored if aFileLocation is COPY_FILE_TO_CACHE)

aLogicalName - the "logical" name of a file unrelated to the physical name

aType - a description of the file's type (optional and can be null)

aFileLocation - the file location type (see DataCacheFileObject for values)

doWork

public int doWork()

Description copied from class: DataCacheObject

Abstract method for actually getting the data while in the thread

Specified by:

doWork in class DataCacheObject

Returns:

return the new status.