org.treetank.io

Interface IBackend

All Known Implementing Classes:

BerkeleyStorage, CombinedStorage, JCloudsStorage

public interface IBackend

Interface to generate access to the underlaying storage. The underlaying storage is flexible as long as IBackendReader and IBackendWriter -implementations are provided. Utility methods for common interaction with the storage are provided via the IOUtils-class.

Author:

Sebastian Graf, University of Konstanz

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IBackend.IBackendFactory Factory for generating an IBackend-instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closing this storage.
IByteHandler.IByteHandlerPipeline	getByteHandler() Getting the ByteHandlers associated with this Storage.
IBackendReader	getReader() Getting a reader.
IBackendWriter	getWriter() Getting a writer.
void	initialize() Initializing the storage.
boolean	truncate() Truncating a storage.

Method Detail

getWriter

IBackendWriter getWriter()
                         throws TTException

Getting a writer.

Returns:

an IBackendWriter instance

Throws:

TTIOException - if the initalisation fails

TTException

getReader

IBackendReader getReader()
                         throws TTException

Getting a reader.

Returns:

an IBackendReader instance

Throws:

TTIOException - if the initalisation fails

TTException

close

void close()
           throws TTException

Closing this storage.

Throws:

TTIOException - exception to be throwns

TTException

getByteHandler

IByteHandler.IByteHandlerPipeline getByteHandler()

Getting the ByteHandlers associated with this Storage.

Returns:

the IByteHandler.IByteHandlerPipeline transforming bytes before storage

truncate

boolean truncate()
                 throws TTException

Truncating a storage.

Returns:

true if successful, false otherwise

Throws:

TTException - if anything weird happens

initialize

void initialize()
                throws TTIOException

Initializing the storage.

Throws:

TTIOException