DataCacheObject

java.lang.Object
- org.kepler.objectmanager.cache.CacheObject
- - org.kepler.objectmanager.cache.DataCacheObject

All Implemented Interfaces:

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

Direct Known Subclasses:

BufferedDataCacheObject, DataCacheFileObject, EcogridQueryDataCacheItem
```
public abstract class DataCacheObject
extends CacheObject
implements java.lang.Runnable, java.io.Serializable
```
Represents an item in the cache

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`CACHE_BUSY` Description of the Field
`protected static int`	`CACHE_COMPLETE` Description of the Field
`protected static int`	`CACHE_EMPTY` Description of the Field
`protected static int`	`CACHE_ERROR` Description of the Field

Fields inherited from class org.kepler.objectmanager.cache.CacheObject
_attributes, _lsid, _name, _semanticTypes

Constructor Summary

Constructors
Constructor and Description

DataCacheObject()
Constructor

Constructors
Constructor and Description
`DataCacheObject()` Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(DataCacheListener aListener)` Add a listenero
`void`	`clear()` Clear the dat from this cache item
`abstract int`	`doWork()` Abstract method for actually getting the data while in the thread
`java.lang.String`	`getAbsoluteFileName()`
`java.lang.String`	`getBaseFileName()`
`java.util.Date`	`getCreatedDate()`
`java.io.InputStream`	`getDataInputStream()` Return the data as an InputStream.
`java.io.File`	`getFile()`
`java.lang.Object`	`getObject()` return the java object associated with this CacheObject
`java.lang.String`	`getResourceName()`
`protected int`	`getStatus()`
`boolean`	`isBusy()` Returns whether it is busy getting the data
`boolean`	`isEmpty()` Returns whether it is in empty state
`boolean`	`isError()` Returns whether it is in error state
`boolean`	`isReady()` Return the status of getting the data
`void`	`notifyListeners()` Notifies the listener that the "getting" of the data has completed
`void`	`refresh(DataCacheListener aListener)` Refreshes the data from the original source
`void`	`removeAllListeners()` Removes all the listeners
`void`	`removeListener(DataCacheListener aListener)` Removes a listener
`void`	`reset()` Description of the Method
`void`	`run()`
`void`	`setAbsoluteFileName(java.lang.String localFileName)`
`void`	`setBaseFileName(java.lang.String localFileName)`
`void`	`setCreatedDate(java.util.Date createdDate)`
`void`	`setResourceName(java.lang.String resourceName)`
`void`	`start()` Description of the Method
`void`	`stop()`
`java.lang.String`	`toString()` return a string representation of this datacacheobject

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
  - CACHE_BUSY
```
protected static final int CACHE_BUSY
```
    Description of the Field
    
    See Also:
    
    Constant Field Values
  - CACHE_ERROR
```
protected static final int CACHE_ERROR
```
    Description of the Field
    
    See Also:
    
    Constant Field Values
  - CACHE_COMPLETE
```
protected static final int CACHE_COMPLETE
```
    Description of the Field
    
    See Also:
    
    Constant Field Values
  - CACHE_EMPTY
```
protected static final int CACHE_EMPTY
```
    Description of the Field
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataCacheObject
```
public DataCacheObject()
```
    Constructor
- Method Detail
  - setCreatedDate
```
public final void setCreatedDate(java.util.Date createdDate)
```
    Parameters:
    
    createdDate - The mCreatedDate to set.
  - setAbsoluteFileName
```
public final void setAbsoluteFileName(java.lang.String localFileName)
```
    Parameters:
    
    localFileName - The mLocalFileName to set.
  - setBaseFileName
```
public final void setBaseFileName(java.lang.String localFileName)
```
    Parameters:
    
    localFileName - The mLocalFileName to set.
  - setResourceName
```
public final void setResourceName(java.lang.String resourceName)
```
    Parameters:
    
    resourceName - The mResourceName to set.
  - getObject
```
public final java.lang.Object getObject()
```
    Description copied from class: CacheObject
    
    return the java object associated with this CacheObject
    
    Specified by:
    
    getObject in interface CacheObjectInterface
    
    Specified by:
    
    getObject in class CacheObject
  - getFile
```
public final java.io.File getFile()
```
  - getDataInputStream
```
public final java.io.InputStream getDataInputStream()
```
    Return the data as an InputStream. The data is read from the cached file on disk, so this method assumes the cache item has already been retrieved. If not, or if there is an error, then the return value will be null.
    
    Returns:
    
    InputStream representing the data
  - isEmpty
```
public final boolean isEmpty()
```
    Returns whether it is in empty state
  - isReady
```
public final boolean isReady()
```
    Return the status of getting the data
  - isBusy
```
public final boolean isBusy()
```
    Returns whether it is busy getting the data
  - isError
```
public final boolean isError()
```
    Returns whether it is in error state
  - getCreatedDate
```
public final java.util.Date getCreatedDate()
```
    Returns:
    
    Returns the mCreatedDate.
  - getAbsoluteFileName
```
public final java.lang.String getAbsoluteFileName()
```
    Returns:
    
    Returns the mLocalFileName.
  - getBaseFileName
```
public final java.lang.String getBaseFileName()
```
    Returns:
    
    Returns the mLocalFileName.
  - getResourceName
```
public final java.lang.String getResourceName()
```
    Returns:
    
    Returns the mResourceName.
  - getStatus
```
protected final int getStatus()
```
    Returns:
    
    Returns the mStatus.
  - addListener
```
public final void addListener(DataCacheListener aListener)
```
    Add a listenero
    
    Parameters:
    
    aListener - the listener to add
  - removeListener
```
public final void removeListener(DataCacheListener aListener)
```
    Removes a listener
    
    Parameters:
    
    aListener - the listener to remove
  - removeAllListeners
```
public final void removeAllListeners()
```
    Removes all the listeners
  - notifyListeners
```
public final void notifyListeners()
```
    Notifies the listener that the "getting" of the data has completed
  - refresh
```
public final void refresh(DataCacheListener aListener)
```
    Refreshes the data from the original source
    
    Parameters:
    
    aListener -
  - reset
```
public final void reset()
```
    Description of the Method
  - clear
```
public final void clear()
```
    Clear the dat from this cache item
  - doWork
```
public abstract int doWork()
```
    Abstract method for actually getting the data while in the thread
    
    Returns:
    
    return the new status.
  - toString
```
public java.lang.String toString()
```
    return a string representation of this datacacheobject
    
    Overrides:
    
    toString in class java.lang.Object
  - start
```
public void start()
```
    Description of the Method
  - stop
```
public void stop()
```
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable

Class DataCacheObject

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

CACHE_BUSY

CACHE_ERROR

CACHE_COMPLETE

CACHE_EMPTY

Constructor Detail

DataCacheObject

Method Detail

setCreatedDate

setAbsoluteFileName

setBaseFileName

setResourceName

getObject

getFile

getDataInputStream

isEmpty

isReady

isBusy

isError

getCreatedDate

getAbsoluteFileName

getBaseFileName

getResourceName

getStatus

addListener

removeListener

removeAllListeners

notifyListeners

refresh

reset

clear

doWork

toString

start

stop

run