org.ecoinformatics.seek.datasource

Class EcogridCompressedDataCacheItem

java.lang.Object

org.kepler.objectmanager.cache.CacheObject

org.kepler.objectmanager.cache.DataCacheObject

org.kepler.objectmanager.cache.BufferedDataCacheObject

org.ecoinformatics.seek.datasource.EcogridDataCacheItem

org.ecoinformatics.seek.datasource.EcogridCompressedDataCacheItem

All Implemented Interfaces:

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

Direct Known Subclasses:

EcogridGZippedDataCacheItem, EcogridTarArchivedDataCacheItem, EcogridZippedDataCacheItem

public abstract class EcogridCompressedDataCacheItem
extends EcogridDataCacheItem

This class will handle compressed data object(for example a zip file) download from server in Chache system. This class will encapsulate unzip the zip file into a directory and give a api to user to get a local file path by given a file entension. For example: a zip file will be download as 1209.dat(it has xyz.bil, xyz.blw, xyz.hdr, xyz.stx)then the zip file will be unzziped to /cachedir/uncompress/1029.dat. If you give a file extension - bil, it will return /cachedir/uncompress/l029.dat/xyz.bil

Author:

Jing Tao

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	refresh
protected java.io.File	unCompressedCacheItemDir
protected java.lang.String[]	unCompressedFileList
protected java.lang.String	unCompressedFilePath

Fields inherited from class org.ecoinformatics.seek.datasource.EcogridDataCacheItem

mEndPoint

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
EcogridCompressedDataCacheItem() Default constructor
EcogridCompressedDataCacheItem(boolean refresh) Constructor

Method Summary

Modifier and Type	Method and Description
int	doWork() This method will load data from local file first.
boolean	getRefresh() Method to get refresh variable
java.lang.String[]	getUnzippedFilePath(java.lang.String fileExtension) This method will get a file path which matches the given file extension in unzipped file list.
void	setRefresh(boolean refresh) Method to set up refresh variable
abstract void	unCompressCacheItem() This is an abracted method for uncompress cache item.

Methods inherited from class org.ecoinformatics.seek.datasource.EcogridDataCacheItem

downloadDataFromSource, getAttrsForXML, getDataItemFromEcoGrid, getEndPoint, getEntityIdentifier, getIsTarFile, setEndPoint, setEntityIdentifier, setIsTarFile

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

getData, setData

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

unCompressedFilePath

protected java.lang.String unCompressedFilePath

unCompressedCacheItemDir

protected java.io.File unCompressedCacheItemDir

unCompressedFileList

protected java.lang.String[] unCompressedFileList

refresh

protected boolean refresh

Constructor Detail

EcogridCompressedDataCacheItem

public EcogridCompressedDataCacheItem()

Default constructor

EcogridCompressedDataCacheItem

public EcogridCompressedDataCacheItem(boolean refresh)

Constructor

Parameters:

refresh - if the compressed file need be uncompressed again even already has umpressed before

Method Detail

doWork

public int doWork()

This method will load data from local file first. If there is no loca file It will download from server. Then it will unzip the file.

Overrides:

doWork in class EcogridDataCacheItem

Returns:

return the new status.

unCompressCacheItem

public abstract void unCompressCacheItem()
                                  throws java.lang.Exception

This is an abracted method for uncompress cache item. It will be overwritten by subclass - EcogridZippedDataCacheItem, EcogridGZippedDataCacheItem

Throws:

java.lang.Exception

getUnzippedFilePath

public java.lang.String[] getUnzippedFilePath(java.lang.String fileExtension)

This method will get a file path which matches the given file extension in unzipped file list. If no match, null will be returned

Parameters:

fileExtension - String

Returns:

String[]

setRefresh

public void setRefresh(boolean refresh)

Method to set up refresh variable

Parameters:

refresh - boolean

getRefresh

public boolean getRefresh()

Method to get refresh variable

Returns:

boolean