net.icite.datastore
Interface DatastoreBase

All Known Implementing Classes:

WTFBase

public interface DatastoreBase

DatastoreBase is meant to be a generic interface to pluggable datastores, but it just matches the WTFBase methods at this point. A particular liability is that WTFBase relates to files, and there are a bunch of file-operation specific methods in this DatastoreBase. But, obviously, database datastores would likely use database and table names in places where WTFBase relates to files. So, this interface should be considered unstable at this point!

Version:

$Id: DatastoreBase.java,v 1.0 2005/04/30 17:15:00 jay Exp $

Author:

Jay Fienberg

Method Summary

void	addToCatalog(java.lang.Object key, java.util.ArrayList alist)
void	addToCatalog(java.lang.Object key, java.util.Map map)
java.lang.String	catalogDump()
java.lang.String	fileWatchDump()
java.lang.String	getCanonicalSourceName(java.lang.String filecomp, java.lang.String fileDir)
java.util.ArrayList	getCatalogKey(org.apache.commons.collections.keyvalue.MultiKey key)
java.util.ArrayList	getCatalogKey(java.lang.Object key)
java.util.ArrayList	getCatalogKey(java.lang.String key)
java.lang.String	getComparator()
java.util.ArrayList	getNewView(java.util.ArrayList keys)
java.lang.String	getSecureHash(java.lang.String data)
boolean	isFileWatched(java.lang.String file)
boolean	isWatchedFileCurrent(java.lang.String fullFile)
boolean	isWatchedFileCurrent(java.lang.String file, java.lang.String fileDir)
boolean	isWatchedFileMissing(java.lang.String fullFile)
void	load(java.util.ArrayList filelist, java.lang.String defaultEncoding, java.lang.String fileDir)
void	load(java.lang.String file, java.lang.String encoding, java.lang.String fileDir)
void	loadFromQueue()
void	runFileWatcher()
void	setComparator(java.lang.String comparator)
void	setDefaultCatalogKeyValue(java.lang.String val)
void	setDefaultMultiSectionMode(boolean mode)
void	setFileWatchTimer(int timeInMinutes)
void	setKeysToClearOnLoad(java.lang.String[] keys)
void	updateWatchedFile(java.lang.String file, java.lang.Long mod, boolean mis)
void	watchFile(java.util.ArrayList filelist, java.lang.String defaultEncoding, boolean queue)
void	watchFile(java.util.ArrayList filelist, java.lang.String defaultEncoding, java.lang.String fileDir, boolean queue)
void	watchFile(java.lang.String filename, java.lang.String encoding, boolean queue)
void	watchFile(java.lang.String filename, java.lang.String defaultEncoding, java.lang.String fileDir, boolean queue)

Method Detail

load

public void load(java.lang.String file,
                 java.lang.String encoding,
                 java.lang.String fileDir)

load

public void load(java.util.ArrayList filelist,
                 java.lang.String defaultEncoding,
                 java.lang.String fileDir)

setDefaultCatalogKeyValue

public void setDefaultCatalogKeyValue(java.lang.String val)

setDefaultMultiSectionMode

public void setDefaultMultiSectionMode(boolean mode)

setKeysToClearOnLoad

public void setKeysToClearOnLoad(java.lang.String[] keys)

addToCatalog

public void addToCatalog(java.lang.Object key,
                         java.util.Map map)

addToCatalog

public void addToCatalog(java.lang.Object key,
                         java.util.ArrayList alist)

getCatalogKey

public java.util.ArrayList getCatalogKey(java.lang.Object key)

getCatalogKey

public java.util.ArrayList getCatalogKey(java.lang.String key)

getCatalogKey

public java.util.ArrayList getCatalogKey(org.apache.commons.collections.keyvalue.MultiKey key)

getCanonicalSourceName

public java.lang.String getCanonicalSourceName(java.lang.String filecomp,
                                               java.lang.String fileDir)

getNewView

public java.util.ArrayList getNewView(java.util.ArrayList keys)

watchFile

public void watchFile(java.lang.String filename,
                      java.lang.String defaultEncoding,
                      java.lang.String fileDir,
                      boolean queue)

watchFile

public void watchFile(java.util.ArrayList filelist,
                      java.lang.String defaultEncoding,
                      java.lang.String fileDir,
                      boolean queue)

watchFile

public void watchFile(java.lang.String filename,
                      java.lang.String encoding,
                      boolean queue)

watchFile

public void watchFile(java.util.ArrayList filelist,
                      java.lang.String defaultEncoding,
                      boolean queue)

updateWatchedFile

public void updateWatchedFile(java.lang.String file,
                              java.lang.Long mod,
                              boolean mis)

isWatchedFileCurrent

public boolean isWatchedFileCurrent(java.lang.String file,
                                    java.lang.String fileDir)

isWatchedFileCurrent

public boolean isWatchedFileCurrent(java.lang.String fullFile)

isWatchedFileMissing

public boolean isWatchedFileMissing(java.lang.String fullFile)

isFileWatched

public boolean isFileWatched(java.lang.String file)

loadFromQueue

public void loadFromQueue()

setFileWatchTimer

public void setFileWatchTimer(int timeInMinutes)

runFileWatcher

public void runFileWatcher()

catalogDump

public java.lang.String catalogDump()

fileWatchDump

public java.lang.String fileWatchDump()

getComparator

public java.lang.String getComparator()

setComparator

public void setComparator(java.lang.String comparator)

getSecureHash

public java.lang.String getSecureHash(java.lang.String data)
                               throws java.security.NoSuchAlgorithmException

Throws:

java.security.NoSuchAlgorithmException