org.treetank.io.berkeley

Class BerkeleyStorage

java.lang.Object

org.treetank.io.berkeley.BerkeleyStorage

All Implemented Interfaces:

IBackend

public final class BerkeleyStorage
extends Object
implements IBackend

Factory class to build up IBackendReader IBackendWriter instances for the Treetank Framework. After all this class is implemented as a Singleton to hold one BerkeleyStorage per SessionConfiguration.

Author:

Sebastian Graf, University of Konstanz

Nested Class Summary

Nested classes/interfaces inherited from interface org.treetank.io.IBackend

IBackend.IBackendFactory

Constructor Summary

Constructors

Constructor and Description
BerkeleyStorage(Properties pProperties, IDataFactory pDataFac, IMetaEntryFactory pMetaFac, IByteHandler.IByteHandlerPipeline pByteHandler) Simple constructor.

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.
String	toString()
boolean	truncate() Truncating a storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

BerkeleyStorage

@Inject
public BerkeleyStorage(Properties pProperties,
                      IDataFactory pDataFac,
                      IMetaEntryFactory pMetaFac,
                      IByteHandler.IByteHandlerPipeline pByteHandler)
                throws TTIOException

Simple constructor.

Parameters:

pProperties - not only the file associated with the database

pDataFac - factory for the datas

pMetaFac - factory for meta bucket

pByteHandler - handling any bytes

Throws:

TTIOException - of something odd happens while database-connection

Method Detail

initialize

public void initialize()
                throws TTIOException

Initializing the storage.

Specified by:

initialize in interface IBackend

Throws:

TTIOException

getReader

public IBackendReader getReader()
                         throws TTIOException

Getting a reader.

Specified by:

getReader in interface IBackend

Returns:

an IBackendReader instance

Throws:

TTIOException - if the initalisation fails

getWriter

public IBackendWriter getWriter()
                         throws TTIOException

Getting a writer.

Specified by:

getWriter in interface IBackend

Returns:

an IBackendWriter instance

Throws:

TTIOException - if the initalisation fails

close

public void close()
           throws TTIOException

Closing this storage.

Specified by:

close in interface IBackend

Throws:

TTIOException - exception to be throwns

getByteHandler

public IByteHandler.IByteHandlerPipeline getByteHandler()

Description copied from interface: IBackend

Getting the ByteHandlers associated with this Storage.

Specified by:

getByteHandler in interface IBackend

Returns:

the IByteHandler.IByteHandlerPipeline transforming bytes before storage

truncate

public boolean truncate()
                 throws TTException

Truncating a storage.

Specified by:

truncate in interface IBackend

Returns:

true if successful, false otherwise

Throws:

TTException - if anything weird happens

toString

public String toString()

Overrides:

toString in class Object