water.persist

Class Persist

java.lang.Object

water.persist.Persist

Direct Known Subclasses:

PersistNFS

public abstract class Persist
extends java.lang.Object

Abstract class describing various persistence targets.

• store(Value v) - Store a Value, using storage space.
• load(Value v) - Load a previously stored Value.
• delete(Value v) - Free storage from a previously store Value.

This class is used to implement both user-mode swapping, and the initial load of files - typically raw text for parsing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Persist.PersistEntry

Constructor Summary

Constructors

Constructor and Description
Persist()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.util.List<java.lang.String>	calcTypeaheadMatches(java.lang.String filter, int limit) Calculate typeahead matches for src
boolean	canHandle(java.lang.String path) Returns true if the persist layer understands given path.
abstract void	cleanUp() Delete persistent storage on startup and shutdown
java.io.OutputStream	create(java.lang.String path, boolean overwrite) Create a new file and return OutputStream for writing.
boolean	delete(java.lang.String path)
abstract void	delete(Value v) Reclaim space from a previously stored Value
boolean	exists(java.lang.String path)
java.lang.String	getHomeDirectory()
long	getTotalSpace() Total storage space, or -1 for unknown
long	getUsableSpace() Usable storage space, or -1 for unknown
abstract void	importFiles(java.lang.String path, java.lang.String pattern, java.util.ArrayList<java.lang.String> files, java.util.ArrayList<java.lang.String> keys, java.util.ArrayList<java.lang.String> fails, java.util.ArrayList<java.lang.String> dels)
boolean	isDirectory(java.lang.String path)
protected static java.lang.String	key2Str(Key k)
long	length(java.lang.String path)
Persist.PersistEntry[]	list(java.lang.String path)
abstract byte[]	load(Value v) Load a previously stored Value
boolean	mkdirs(java.lang.String path)
java.io.InputStream	open(java.lang.String path)
boolean	rename(java.lang.String fromPath, java.lang.String toPath)
abstract void	store(Value v) Store a Value into persistent storage, consuming some storage space.
abstract Key	uriToKey(java.net.URI uri) Transform given uri into file vector holding file name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Persist

public Persist()

Method Detail

store

public abstract void store(Value v)
                    throws java.io.IOException

Store a Value into persistent storage, consuming some storage space.

Throws:

java.io.IOException

load

public abstract byte[] load(Value v)
                     throws java.io.IOException

Load a previously stored Value

Throws:

java.io.IOException

delete

public abstract void delete(Value v)

Reclaim space from a previously stored Value

getUsableSpace

public long getUsableSpace()

Usable storage space, or -1 for unknown

getTotalSpace

public long getTotalSpace()

Total storage space, or -1 for unknown

uriToKey

public abstract Key uriToKey(java.net.URI uri)
                      throws java.io.IOException

Transform given uri into file vector holding file name.

Throws:

java.io.IOException

cleanUp

public abstract void cleanUp()

Delete persistent storage on startup and shutdown

calcTypeaheadMatches

public abstract java.util.List<java.lang.String> calcTypeaheadMatches(java.lang.String filter,
                                                    int limit)

Calculate typeahead matches for src

Parameters:

filter - Source string to match for typeahead

limit - Max number of entries to return

Returns:

List of matches

importFiles

public abstract void importFiles(java.lang.String path,
               java.lang.String pattern,
               java.util.ArrayList<java.lang.String> files,
               java.util.ArrayList<java.lang.String> keys,
               java.util.ArrayList<java.lang.String> fails,
               java.util.ArrayList<java.lang.String> dels)

key2Str

protected static java.lang.String key2Str(Key k)

getHomeDirectory

public java.lang.String getHomeDirectory()

list

public Persist.PersistEntry[] list(java.lang.String path)

exists

public boolean exists(java.lang.String path)

isDirectory

public boolean isDirectory(java.lang.String path)

length

public long length(java.lang.String path)

open

public java.io.InputStream open(java.lang.String path)

mkdirs

public boolean mkdirs(java.lang.String path)

rename

public boolean rename(java.lang.String fromPath,
             java.lang.String toPath)

create

public java.io.OutputStream create(java.lang.String path,
                          boolean overwrite)

Create a new file and return OutputStream for writing. The method creates all directories which does not exists on the referenced path.

Parameters:

path - persist layer specific path

overwrite - overwrite destination file

Returns:

output stream

Throws:

java.io.IOException - in case of underlying FS error

delete

public boolean delete(java.lang.String path)

canHandle

public boolean canHandle(java.lang.String path)

Returns true if the persist layer understands given path.