org.kepler.objectmanager.cache

Class CacheManager

java.lang.Object

org.kepler.objectmanager.cache.CacheManager

public class CacheManager
extends java.lang.Object

This class represents a disk cache of CacheObjects. The cache manages cache objects by calling their lifecycle event handlers and serializing every time a change is made. Objects in the cache each have a unique lsid. Once an object is in the cache, it will not be updated unless the lsid changes. this class uses hsql to keep track of cache entries.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_SEMTYPES_TABLE_NAME
protected static java.lang.String	cachePath
static java.lang.String	CACHETABLENAME
static java.lang.String	tmpPath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CacheManager() Construct a new CacheManager

Method Summary

Modifier and Type	Method and Description
void	addCacheListener(CacheListener listener) add a CacheListener to listen for cache events
void	addKAREntryHandler(KAREntryHandler keh)
void	clearCache() clear the cache of all contents
int	countDB() debug method to count the contents of the table * @throws CacheException
java.util.Vector<CacheContent>	getCachedContents()
java.util.Vector<CacheContent>	getCachedContents(java.lang.String type)
java.util.Vector<KeplerLSID>	getCachedLsids() Return a complete list of KeplerLSIDs for everything that is in the cache.
java.util.Vector<KeplerLSID>	getCachedLsids(KeplerLSID lsid)
java.util.List<KeplerLSID>	getCachedLsidsForClass(java.lang.String className) Get a list of LSIDs for a class name.
java.util.Iterator<CacheObjectInterface>	getCacheObjectIterator() return an iterator of all of the CacheObjectInterfaces in the cache
java.util.Iterator<CacheObjectInterface>	getCacheObjectIterator(java.lang.String type)
static java.lang.String	getDatabaseSchemaName() Get the name of the cache database schema.
java.lang.Long	getHighestCachedLsidRevision(KeplerLSID lsid)
CacheObject	getHighestCacheObjectRevision(KeplerLSID anLsid) Return the CacheObject that has the highest revision number and matches the given LSID, return null if not found.
static CacheManager	getInstance() create a new singleton instance of CacheManager
java.util.Collection<KAREntryHandler>	getKAREntryHandlers()
CacheObjectInterface	getObject(KeplerLSID lsid) return the CacheObjectInterface with the specified lsid.
java.util.Vector<KeplerLSID>	getSemanticTypesFor(KeplerLSID lsid) Return a list of Semantic Types for the given LSID.
java.io.File	getTempFile() returns a temp file that is guaranteed to be around for one kepler session but could be deleted if the cache gets too full.
void	insertObject(CacheObjectInterface co) insert a new CacheObjectInterface into the cache.
boolean	isContained(KeplerLSID lsid) return true of the given lsid has an associated object in the cache
void	removeObject(KeplerLSID lsid) remove the CacheObjectInterface with the specified lsid.
java.lang.String	showDB() debug method to show the contents of the table
static void	shutdown() Shutdown the cache manager.
void	updateObject(CacheObjectInterface co) update a CacheObjectInterface in the cache.

Methods inherited from class java.lang.Object

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

Field Detail

cachePath

protected static final java.lang.String cachePath

tmpPath

public static final java.lang.String tmpPath

CACHETABLENAME

public static final java.lang.String CACHETABLENAME

See Also:

Constant Field Values

CACHE_SEMTYPES_TABLE_NAME

public static final java.lang.String CACHE_SEMTYPES_TABLE_NAME

See Also:

Constant Field Values

Constructor Detail

CacheManager

protected CacheManager()
                throws CacheException

Construct a new CacheManager

Throws:

CacheException

Method Detail

getInstance

public static CacheManager getInstance()
                                throws CacheException

create a new singleton instance of CacheManager

Throws:

CacheException

shutdown

public static void shutdown()

Shutdown the cache manager.

getTempFile

public java.io.File getTempFile()

returns a temp file that is guaranteed to be around for one kepler session but could be deleted if the cache gets too full.

addKAREntryHandler

public void addKAREntryHandler(KAREntryHandler keh)

Parameters:

keh -

getKAREntryHandlers

public java.util.Collection<KAREntryHandler> getKAREntryHandlers()

insertObject

public void insertObject(CacheObjectInterface co)
                  throws CacheException

insert a new CacheObjectInterface into the cache.

Parameters:

co - the cache object to insert

Throws:

CacheException

updateObject

public void updateObject(CacheObjectInterface co)
                  throws CacheException

update a CacheObjectInterface in the cache.

Throws:

CacheException

removeObject

public void removeObject(KeplerLSID lsid)
                  throws CacheException

remove the CacheObjectInterface with the specified lsid.

Parameters:

lsid -

Throws:

CacheException

showDB

public java.lang.String showDB()
                        throws CacheException,
                               java.sql.SQLException

debug method to show the contents of the table

Throws:

CacheException, - SQLException

CacheException

java.sql.SQLException

countDB

public int countDB()
            throws CacheException,
                   java.sql.SQLException

debug method to count the contents of the table * @throws CacheException

Throws:

CacheException

java.sql.SQLException

getObject

public CacheObjectInterface getObject(KeplerLSID lsid)
                               throws CacheException

return the CacheObjectInterface with the specified lsid. Returns null if the object is not in the cache and cannot be resolved.

Parameters:

lsid -

Throws:

CacheException - when there is an issue with the cache.

getCachedContents

public java.util.Vector<CacheContent> getCachedContents()

getCachedContents

public java.util.Vector<CacheContent> getCachedContents(java.lang.String type)

Parameters:

type -

Returns:

getCachedLsids

public java.util.Vector<KeplerLSID> getCachedLsids()

Return a complete list of KeplerLSIDs for everything that is in the cache.

Returns:

getCachedLsids

public java.util.Vector<KeplerLSID> getCachedLsids(KeplerLSID lsid)

Parameters:

lsid -

Returns:

getCachedLsidsForClass

public java.util.List<KeplerLSID> getCachedLsidsForClass(java.lang.String className)
                                                  throws java.lang.Exception

Get a list of LSIDs for a class name.

Throws:

java.lang.Exception

getHighestCachedLsidRevision

public java.lang.Long getHighestCachedLsidRevision(KeplerLSID lsid)

Parameters:

lsid -

Returns:

getSemanticTypesFor

public java.util.Vector<KeplerLSID> getSemanticTypesFor(KeplerLSID lsid)

Return a list of Semantic Types for the given LSID.

Parameters:

lsid -

Returns:

getCacheObjectIterator

public java.util.Iterator<CacheObjectInterface> getCacheObjectIterator()
                                                                throws CacheException

return an iterator of all of the CacheObjectInterfaces in the cache

Throws:

CacheException

getHighestCacheObjectRevision

public CacheObject getHighestCacheObjectRevision(KeplerLSID anLsid)
                                          throws CacheException

Return the CacheObject that has the highest revision number and matches the given LSID, return null if not found.

Parameters:

anLsid -

Returns:

Throws:

CacheException

getCacheObjectIterator

public java.util.Iterator<CacheObjectInterface> getCacheObjectIterator(java.lang.String type)
                                                                throws CacheException

Parameters:

type -

Returns:

all cache objects that are of the specified type

Throws:

CacheException

isContained

public boolean isContained(KeplerLSID lsid)
                    throws CacheException

return true of the given lsid has an associated object in the cache

Parameters:

lsid -

Throws:

CacheException

clearCache

public void clearCache()
                throws java.sql.SQLException,
                       CacheException

clear the cache of all contents

Throws:

java.sql.SQLException

CacheException

addCacheListener

public void addCacheListener(CacheListener listener)

add a CacheListener to listen for cache events

getDatabaseSchemaName

public static java.lang.String getDatabaseSchemaName()

Get the name of the cache database schema.