org.kepler.objectmanager.cache

Class CacheObject

java.lang.Object

org.kepler.objectmanager.cache.CacheObject

All Implemented Interfaces:

java.io.Serializable, CacheObjectInterface

Direct Known Subclasses:

ActorCacheObject, DataCacheObject, RawDataCacheObject, ReportLayoutCacheObject, WorkflowRunCacheObject

public abstract class CacheObject
extends java.lang.Object
implements CacheObjectInterface, java.io.Serializable

Class that represents an object in the ObjectCache. This class should be extended by each type of object that wants to control its own lifecycle events and serialization events.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable<java.lang.String,java.lang.String>	_attributes
protected KeplerLSID	_lsid
protected java.lang.String	_name
protected java.util.Vector<java.lang.String>	_semanticTypes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CacheObject() default constructor. if you use this constrctor, you'll need to set the name and lsid through the setLSID and setName methods.
	CacheObject(java.lang.String name, KeplerLSID lsid) construct a new CacheObject

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, java.lang.String value) set a user configured attribute on the CacheObject
java.lang.String	getAttribute(java.lang.String name) get the attribute with the specified name
java.util.Set<java.lang.String>	getAttributeNames()
KeplerLSID	getLSID() get the lsid for this object
java.lang.String	getName() get the name of this object
abstract java.lang.Object	getObject() return the java object associated with this CacheObject
java.util.Vector<java.lang.String>	getSemanticTypes() this returns the semantic types vector
void	objectAdded() call back for when this object is added to the cache.
void	objectPurged() call back for when this object is purged by ObjectCache.
void	objectRemoved() call back for when this object is removed by the user.
void	removeAttribute(java.lang.String name) remove the attribute with the given name and return it.
void	setLSID(KeplerLSID lsid) set the lsid
void	setName(java.lang.String name) set the name
void	setSemanticTypes(java.util.Vector<java.lang.String> semTypes) this returns the semantic types vector

Methods inherited from class java.lang.Object

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

Field Detail

_name

protected transient java.lang.String _name

_lsid

protected transient KeplerLSID _lsid

_semanticTypes

protected java.util.Vector<java.lang.String> _semanticTypes

_attributes

protected java.util.Hashtable<java.lang.String,java.lang.String> _attributes

Constructor Detail

CacheObject

protected CacheObject()

default constructor. if you use this constrctor, you'll need to set the name and lsid through the setLSID and setName methods.

CacheObject

public CacheObject(java.lang.String name,
                   KeplerLSID lsid)

construct a new CacheObject

Method Detail

getName

public java.lang.String getName()

get the name of this object

Specified by:

getName in interface CacheObjectInterface

getLSID

public KeplerLSID getLSID()

get the lsid for this object

Specified by:

getLSID in interface CacheObjectInterface

setLSID

public void setLSID(KeplerLSID lsid)

set the lsid

Specified by:

setLSID in interface CacheObjectInterface

setName

public void setName(java.lang.String name)

set the name

Specified by:

setName in interface CacheObjectInterface

setSemanticTypes

public void setSemanticTypes(java.util.Vector<java.lang.String> semTypes)

this returns the semantic types vector

getSemanticTypes

public java.util.Vector<java.lang.String> getSemanticTypes()

this returns the semantic types vector

Returns:

The semanticTypes value

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)

set a user configured attribute on the CacheObject

Specified by:

addAttribute in interface CacheObjectInterface

getAttribute

public java.lang.String getAttribute(java.lang.String name)

get the attribute with the specified name

Specified by:

getAttribute in interface CacheObjectInterface

getAttributeNames

public java.util.Set<java.lang.String> getAttributeNames()

removeAttribute

public void removeAttribute(java.lang.String name)

remove the attribute with the given name and return it.

Specified by:

removeAttribute in interface CacheObjectInterface

getObject

public abstract java.lang.Object getObject()

return the java object associated with this CacheObject

Specified by:

getObject in interface CacheObjectInterface

objectAdded

public void objectAdded()

call back for when this object is added to the cache. This method should be overridden by derviced classes if needed. Default action is to do nothing.

Specified by:

objectAdded in interface CacheObjectInterface

objectRemoved

public void objectRemoved()

call back for when this object is removed by the user. This method should be overridden by derived classes if needed. Default action is to do nothing.

Specified by:

objectRemoved in interface CacheObjectInterface

objectPurged

public void objectPurged()

call back for when this object is purged by ObjectCache. This method should be overridden by derived classes if needed. Default action is to do nothing.

Specified by:

objectPurged in interface CacheObjectInterface