org.treetank.api

Interface IStorage

All Known Implementing Classes:

Storage

public interface IStorage

This interface describes storage-instances handled by Treetank. A IStorage is a persistent place where all data is stored. Resources must be created within this IStorage with the help of ResourceConfigurations. //Creating the Storage Storage.createDatabase(new StorageConfiguration(FILE)); final IStorage storage = Storage.openStorage(FILE); //Getting a ResourceConfiguration over Guice. storage.createResource(mResourceConfig); The access to the data is done with the help of ISessions: //Ensure, storage and resources are created final IStorage storage = Storage.openStorage(FILE); final ISession session = storage.getSession(new SessionConfiguration(RESOURCENAME, KEY)); final IBucketReadTrx pRtx = session.beginBucketRtx(REVISION); final IBucketWriteTrx pWtx = session.beginBucketWtx();

Author:

Sebastian Graf, University of Konstanz

Method Summary

Methods

Modifier and Type	Method and Description
boolean	close() Closing the database for further access.
boolean	createResource(ResourceConfiguration pResConf) Initialization of a resource.
boolean	existsResource(String pResourceName) Is the resource within this database existing?
File	getLocation() Getting the file location of this database.
ISession	getSession(SessionConfiguration pSessionConf) Getting the session associated within this database.
String[]	listResources() Listing all resources within this database.
boolean	truncateResource(SessionConfiguration pResConf) Truncating a resource.

Method Detail

createResource

boolean createResource(ResourceConfiguration pResConf)
                       throws TTException

Initialization of a resource. Since databases can consist out of several resources, those can be created within this method. This includes only the initialization, the creation of a suitable folder structure must take beforehand for example within the creation of properties. This is necessary because of Guice relying on completely provided structures for their data-backends.

Parameters:

pResConf - the config of the resource

Returns:

boolean with true if successful, false otherwise

Throws:

TTIOException - if anything happens while creating the resource

TTException

getSession

ISession getSession(SessionConfiguration pSessionConf)
                    throws TTException

Getting the session associated within this database.

Parameters:

pSessionConf - SessionConfiguration reference

Returns:

the session

Throws:

TTException - if can't get session

truncateResource

boolean truncateResource(SessionConfiguration pResConf)
                         throws TTException

Truncating a resource. This includes the removal of all data stored within this resource.

Parameters:

pResConf - storing the name of the resource

Throws:

TTException - if anything weird happens

existsResource

boolean existsResource(String pResourceName)

Is the resource within this database existing?

Parameters:

pResourceName - ot be checked

Returns:

true, if existing; false otherwise

listResources

String[] listResources()

Listing all resources within this database.

Returns:

all resources

getLocation

File getLocation()

Getting the file location of this database.

Returns:

the File of this database

close

boolean close()
              throws TTException

Closing the database for further access.

Returns:

true if successful, false otherwise

Throws:

TTException - if anything happens within treetank.