org.treetank.api

Interface IBucketReadTrx

All Known Subinterfaces:

IBucketWriteTrx

All Known Implementing Classes:

BucketReadTrx, BucketWriteTrx

public interface IBucketReadTrx

Read-Transaction of a bucket ensuring read-only access to any buckets. The transaction must be bound to a revision and bases on a session. //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); Each IBucketReadTrx can afterwards get datas from the bucket-layer and the underlaying backend. Note that each session furthermore has access to a centralized store of common strings referencable over a key.

Author:

Sebastian Graf, University of Konstanz

Method Summary

Methods

Modifier and Type	Method and Description
boolean	close() Close the transaction.
IData	getData(long pKey) Getting the data related to a key.
MetaBucket	getMetaBucket() Getting the map with the entire mapping for retrieving meta-information related to the bundle.
long	getRevision() Getting the revision number of this transaction
boolean	isClosed() Check if transaction is closed.

Method Detail

getData

IData getData(long pKey)
              throws TTIOException

Getting the data related to a key.

Parameters:

pKey - the key of the data

Returns:

a suitable IData

Throws:

TTException - if anything weird happens

TTIOException

getRevision

long getRevision()
                 throws TTIOException

Getting the revision number of this transaction

Returns:

the revision number of this transaction

Throws:

TTIOException - if deserialization fails.

close

boolean close()
              throws TTIOException

Close the transaction.

Returns:

true if successful, false otherwise

Throws:

TTIOException - if anything weird happens

isClosed

boolean isClosed()

Check if transaction is closed.

Returns:

true if closed, false otherwise

getMetaBucket

MetaBucket getMetaBucket()

Getting the map with the entire mapping for retrieving meta-information related to the bundle.

Returns:

the meta bucket