water.persist

Class PersistFS

java.lang.Object

water.persist.Persist

water.persist.PersistFS

public final class PersistFS
extends Persist

Persistence backend using local file system.

Nested Class Summary

Nested classes/interfaces inherited from class water.persist.Persist

Persist.PersistEntry

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	calcTypeaheadMatches(java.lang.String src, int limit) Calculate typeahead matches for src
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)
void	delete(Value v) Reclaim space from a previously stored Value
boolean	exists(java.lang.String path)
java.io.File	getFile(Value v) Get destination file where value is stored
java.lang.String	getParent(java.lang.String path)
long	getTotalSpace() Total storage space, or -1 for unknown
long	getUsableSpace() Usable storage space, or -1 for unknown
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)
Persist.PersistEntry[]	list(java.lang.String path)
byte[]	load(Value v) Load a previously stored Value
boolean	mkdirs(java.lang.String path)
java.io.InputStream	open(java.lang.String path)
void	store(Value v) Store a Value into persistent storage, consuming some storage space.
Key	uriToKey(java.net.URI uri) Transform given uri into file vector holding file name.

Methods inherited from class water.persist.Persist

canHandle, getHomeDirectory, isSeekableOpenSupported, key2Str, length, load, openSeekable, rename, wrapSeekable

Methods inherited from class java.lang.Object

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

Method Detail

cleanUp

public void cleanUp()

Description copied from class: Persist

Delete persistent storage on startup and shutdown

Specified by:

cleanUp in class Persist

getFile

public java.io.File getFile(Value v)

Get destination file where value is stored

Parameters:

v - any value from K/V

Returns:

location of file where value is/could be stored

load

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

Description copied from class: Persist

Load a previously stored Value

Specified by:

load in class Persist

Throws:

java.io.IOException

store

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

Description copied from class: Persist

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

Specified by:

store in class Persist

Throws:

java.io.IOException

delete

public boolean delete(java.lang.String path)

Overrides:

delete in class Persist

delete

public void delete(Value v)

Description copied from class: Persist

Reclaim space from a previously stored Value

Specified by:

delete in class Persist

getUsableSpace

public long getUsableSpace()

Description copied from class: Persist

Usable storage space, or -1 for unknown

Overrides:

getUsableSpace in class Persist

getTotalSpace

public long getTotalSpace()

Description copied from class: Persist

Total storage space, or -1 for unknown

Overrides:

getTotalSpace in class Persist

uriToKey

public Key uriToKey(java.net.URI uri)

Description copied from class: Persist

Transform given uri into file vector holding file name.

Specified by:

uriToKey in class Persist

calcTypeaheadMatches

public java.util.ArrayList<java.lang.String> calcTypeaheadMatches(java.lang.String src,
                                                                  int limit)

Description copied from class: Persist

Calculate typeahead matches for src

Specified by:

calcTypeaheadMatches in class Persist

Parameters:

src - Source string to match for typeahead

limit - Max number of entries to return

Returns:

List of matches

importFiles

public 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)

Specified by:

importFiles in class Persist

create

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

Description copied from class: Persist

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

Overrides:

create in class Persist

Parameters:

path - persist layer specific path

overwrite - overwrite destination file

Returns:

output stream

list

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

Overrides:

list in class Persist

open

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

Overrides:

open in class Persist

mkdirs

public boolean mkdirs(java.lang.String path)

Overrides:

mkdirs in class Persist

exists

public boolean exists(java.lang.String path)

Overrides:

exists in class Persist

getParent

public java.lang.String getParent(java.lang.String path)

Overrides:

getParent in class Persist

isDirectory

public boolean isDirectory(java.lang.String path)

Overrides:

isDirectory in class Persist