Package org.treetank.api

TreeTank API This package contains the public TreeTank API.

See: Description

Interface Summary

Interface	Description
IBucketReadTrx	Read-Transaction of a bucket ensuring read-only access to any buckets.
IBucketWriteTrx	Write-Transaction of a bucket ensuring read- and write access to any buckets.
IData	Overall IData-Interface for the interaction with the bucket-layer.
IDataFactory	Factory to generate datas out of raw data.
IMetaEntry	All entries in the MetaBucket must implement this interface for guaranteeing serialization.
IMetaEntryFactory	Creating MetaEntries based on the implementation and the bundle.
ISession	Each IStorage contains multiple resources.
IStorage	This interface describes storage-instances handled by Treetank.

Package org.treetank.api Description

TreeTank API This package contains the public TreeTank API. Users will have to connect to any TreeTank through this API. Note that for common usage, only access-interfaces provided by this package should be used. Treetank is based on three layers of interaction:

• IStorage: This layer denotes a persistent storage. Each storage can be created using one specific StorageConfiguration. Afterwards, this configuration is valid for the whole lifetime of the database. Each IStorage can hold multiple resources accessible over ISession.
• ISession: This layer denotes a runtime access on a resource stored in a storage. Only one ISession is allowed at one time. The layer has ability to provide runtime-settings as well. Especially settings regarding the transaction-handling can be provided.
• IBucketReadTrx/IBucketWriteTrx: This layer provided direct access to the database. All access to datas used either a IBucketReadTrx or IBucketWriteTrx.

Additional to these access-interfaces, this api-packages provides direct access-methods for the data-structure:

• IDataFactory: This interface is for deserializing IData-instances in the correct way.

Author:

Marc Kramis, University of Konstanz, Sebastian Graf, University of Konstanz