org.kepler.kar

Class KARCacheManager

java.lang.Object

org.kepler.kar.KARCacheManager

public class KARCacheManager
extends java.lang.Object

This is a singleton class to help manage KARs as they are stored in the cache.

Author:

Aaron Schultz

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KAR_CONTENTS_TABLE_NAME
static java.lang.String	KAR_ERRORS_TABLE_NAME
static java.lang.String	KARS_CACHED_TABLE_NAME Table Names

Constructor Summary

Constructors

Constructor and Description
KARCacheManager()

Method Summary

Modifier and Type	Method and Description
void	clearKARCache()
static KARCacheManager	getInstance() Method for getting an instance of this singleton class.
java.util.Vector<KARCacheContent>	getKARCacheContents() Return all of the KARCacheContents.
java.util.Vector<KARCacheContent>	getKARCacheContents(java.io.File karFile) Return all of the KARCacheContents in the specified KAR file.
java.util.Vector<KARCacheContent>	getKARCacheContents(KeplerLSID lsid) Return all of the KARCacheContents matching the specified lsid.
java.util.Vector<KARCacheContent>	getKARCacheContents(java.lang.String type) Return all of the KARCacheContents matching the specified type.
java.util.Vector<KARCacheError>	getKARCacheErrors()
long	getLastModifiedTimeOfFileInCache(java.lang.String filename) Get the last modified time of a file in the cache.
void	insertEntryIntoCache(java.io.File karFile, KeplerLSID entryLSID, java.lang.String entryName, java.lang.String entryType)
boolean	insertIntoCache(KARFile karFile) Insert a KARFile into the KARS_CACHED table.
boolean	insertKARError(KARFile karFile)
boolean	isCached(java.io.File karFile) Determine if the KAR represented by the supplied File has already been cached.
boolean	isCached(KeplerLSID karLSID) Deprecated. Cached Kars now use the File as the primary key Use isCached(File) instead
boolean	removeKARFromCache(java.io.File karFile) Remove a KAR file from the cache.
boolean	synchronizeKARCacheWithLocalRepositories() Update the KAR cache tables to reflect the kar files on disk.

Methods inherited from class java.lang.Object

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

Field Detail

KARS_CACHED_TABLE_NAME

public static final java.lang.String KARS_CACHED_TABLE_NAME

Table Names

See Also:

Constant Field Values

KAR_ERRORS_TABLE_NAME

public static final java.lang.String KAR_ERRORS_TABLE_NAME

See Also:

Constant Field Values

KAR_CONTENTS_TABLE_NAME

public static final java.lang.String KAR_CONTENTS_TABLE_NAME

See Also:

Constant Field Values

Constructor Detail

KARCacheManager

public KARCacheManager()

Method Detail

getKARCacheErrors

public java.util.Vector<KARCacheError> getKARCacheErrors()

getKARCacheContents

public java.util.Vector<KARCacheContent> getKARCacheContents()

Return all of the KARCacheContents.

Returns:

getKARCacheContents

public java.util.Vector<KARCacheContent> getKARCacheContents(java.lang.String type)

Return all of the KARCacheContents matching the specified type.

Parameters:

type -

Returns:

getKARCacheContents

public java.util.Vector<KARCacheContent> getKARCacheContents(KeplerLSID lsid)

Return all of the KARCacheContents matching the specified lsid.

Parameters:

type -

Returns:

getKARCacheContents

public java.util.Vector<KARCacheContent> getKARCacheContents(java.io.File karFile)

Return all of the KARCacheContents in the specified KAR file.

Parameters:

type -

Returns:

clearKARCache

public void clearKARCache()

synchronizeKARCacheWithLocalRepositories

public boolean synchronizeKARCacheWithLocalRepositories()

Update the KAR cache tables to reflect the kar files on disk.

Returns:

boolean true if the cache was changed because of the synchronization.

removeKARFromCache

public boolean removeKARFromCache(java.io.File karFile)

Remove a KAR file from the cache. The contents of the KAR are also removed only if the objects don't exist in another KAR.

Parameters:

karLSID - the LSID of the kar to remove

Returns:

boolean true if and only if the kar file was removed

insertKARError

public boolean insertKARError(KARFile karFile)

Parameters:

karFile -

Returns:

boolean

insertIntoCache

public boolean insertIntoCache(KARFile karFile)

Insert a KARFile into the KARS_CACHED table. Called from KARFile class. This method DOES NOT insert any of the entries into the cache. Use insertEntryIntoCache and CacheManager.insertObject

Parameters:

karFile -

Returns:

true if and only if the kar was inserted false if already exists or error

insertEntryIntoCache

public void insertEntryIntoCache(java.io.File karFile,
                                 KeplerLSID entryLSID,
                                 java.lang.String entryName,
                                 java.lang.String entryType)

isCached

public boolean isCached(KeplerLSID karLSID)

Deprecated. Cached Kars now use the File as the primary key Use isCached(File) instead

Determine if the KAR represented by the supplied LSID has already been cached.

Parameters:

karLSID -

isCached

public boolean isCached(java.io.File karFile)

Determine if the KAR represented by the supplied File has already been cached. NOTE: this method does not check if the File's contents have changed since cached.

Parameters:

File - karFile

getLastModifiedTimeOfFileInCache

public long getLastModifiedTimeOfFileInCache(java.lang.String filename)

Get the last modified time of a file in the cache. Returns < 0 if the file is not in the cache.

getInstance

public static KARCacheManager getInstance()

Method for getting an instance of this singleton class.