org.treetank.access

Class Storage

java.lang.Object

org.treetank.access.Storage

All Implemented Interfaces:

IStorage

public final class Storage
extends Object
implements IStorage

This class represents one concrete database for enabling several ISession objects.

Author:

Sebastian Graf, University of Konstanz

See Also:

IStorage

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Session>	mSessions Central repository of all running sessions.

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.
static boolean	createStorage(StorageConfiguration pStorageConfig) Creating a storage.
boolean	existsResource(String pResourceName) Is the resource within this database existing?
static boolean	existsStorage(File pStoragePath) Check if Storage exists or not at a given path.
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.
static IStorage	openStorage(File pFile) Open database.
String	toString()
boolean	truncateResource(SessionConfiguration pSesConf) Truncating a resource.
static void	truncateStorage(StorageConfiguration pConf) Truncate a storage.

Methods inherited from class java.lang.Object

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

Field Detail

mSessions

protected final Map<String,Session> mSessions

Central repository of all running sessions.

Method Detail

createStorage

public static boolean createStorage(StorageConfiguration pStorageConfig)
                             throws TTIOException

Creating a storage. This includes loading the storageconfiguration, building up the structure and preparing everything for login.

Parameters:

pStorageConfig - which are used for the storage, including storage location

Returns:

true if creation is valid, false otherwise

Throws:

TTIOException - if something odd happens within the creation process.

truncateStorage

public static void truncateStorage(StorageConfiguration pConf)
                            throws TTException

Truncate a storage. This deletes all relevant data. All running sessions must be closed beforehand.

Parameters:

pConf - the storage at this path should be deleted.

Throws:

TTException - any kind of false Treetank behaviour

existsStorage

public static boolean existsStorage(File pStoragePath)

Check if Storage exists or not at a given path.

Parameters:

pStoragePath - to be checked.

Returns:

true if existing, false otherwise.

createResource

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

Specified by:

createResource in interface IStorage

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

truncateResource

public boolean truncateResource(SessionConfiguration pSesConf)
                         throws TTException

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

Specified by:

truncateResource in interface IStorage

Parameters:

pSesConf - storing the name of the resource

Throws:

TTException - if anything weird happens

openStorage

public static IStorage openStorage(File pFile)
                            throws TTException

Open database. A database can be opened only once. Afterwards the singleton instance bound to the File is given back.

Parameters:

pFile - where the database is located sessionConf a SessionConfiguration object to set up the session

Returns:

IStorage instance.

Throws:

TTException - if something odd happens

getSession

public ISession getSession(SessionConfiguration pSessionConf)
                    throws TTException

Getting the session associated within this database.

Specified by:

getSession in interface IStorage

Parameters:

pSessionConf - SessionConfiguration reference

Returns:

the session

Throws:

TTException - if can't get session

close

public boolean close()
              throws TTException

Closing the database for further access.

Specified by:

close in interface IStorage

Returns:

true if successful, false otherwise

Throws:

TTException - if anything happens within treetank.

existsResource

public boolean existsResource(String pResourceName)

Is the resource within this database existing?

Specified by:

existsResource in interface IStorage

Parameters:

pResourceName - ot be checked

Returns:

true, if existing; false otherwise

listResources

public String[] listResources()

Listing all resources within this database.

Specified by:

listResources in interface IStorage

Returns:

all resources

getLocation

public File getLocation()

Getting the file location of this database.

Specified by:

getLocation in interface IStorage

Returns:

the File of this database

toString

public String toString()

Overrides:

toString in class Object