com.bigdata.journal

Interface IAtomicStore

All Superinterfaces:

IAddressManager, ICounterSetAccess, IRawStore, IStreamStore

All Known Subinterfaces:

IHAJournal, IJournal

All Known Implementing Classes:

AbstractJournal, Journal, JournalDelegate, StoreManager.ManagedJournal

public interface IAtomicStore
extends IRawStore

Interface for low-level operations on a store supporting an atomic commit. Persistent implementations of this interface are restart-safe.

Version:

$Id$

Author:

Bryan Thompson

Field Summary

Fields inherited from interface com.bigdata.rawstore.IAddressManager

NULL

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Abandon the current write set (synchronous).
long	commit() Atomic commit (synchronous).
ICommitRecord	getCommitRecord(long timestamp) Return the ICommitRecord for the most recent committed state whose commit timestamp is less than or equal to timestamp.
long	getRootAddr(int index) The last address stored in the specified root slot as of the last committed state of the store.
IRootBlockView	getRootBlockView() Return a read-only view of the current root block.
boolean	isDirty() Return true if the store has been modified since the last commit() or abort().
void	setCommitter(int index, ICommitter committer) Set a persistence capable data structure for callback during the commit protocol.

Methods inherited from interface com.bigdata.rawstore.IRawStore

close, delete, deleteResources, destroy, force, getFile, getResourceMetadata, getUUID, isFullyBuffered, isOpen, isReadOnly, isStable, read, size, write

Methods inherited from interface com.bigdata.rawstore.IAddressManager

getByteCount, getOffset, getPhysicalAddress, toAddr, toString

Methods inherited from interface com.bigdata.counters.ICounterSetAccess

getCounters

Methods inherited from interface com.bigdata.rawstore.IStreamStore

getInputStream, getOutputStream

Method Detail

abort

void abort()

Abandon the current write set (synchronous).

commit

long commit()

Atomic commit (synchronous).

Note: if the commit fails (by throwing any kind of exception) then you MUST invoke abort() to abandon the current write set.

Returns:

The timestamp assigned to the ICommitRecord -or- 0L if there were no data to commit.

Throws:

IllegalStateException - if the store is not open.

IllegalStateException - if the store is not writable.

isDirty

boolean isDirty()

Return true if the store has been modified since the last commit() or abort().

Returns:

true if store has been modified since last commit() or abort().

setCommitter

void setCommitter(int index,
                ICommitter committer)

Set a persistence capable data structure for callback during the commit protocol.

Note: the committers must be reset after restart or whenever

Parameters:

index - The slot in the root block where the address of the ICommitter will be recorded.

committer - The committer.

getRootAddr

long getRootAddr(int index)

The last address stored in the specified root slot as of the last committed state of the store.

Parameters:

index - The index of the root address to be retrieved.

Returns:

The address stored at that index.

Throws:

IndexOutOfBoundsException - if the index is negative or too large.

getRootBlockView

IRootBlockView getRootBlockView()

Return a read-only view of the current root block.

Returns:

The current root block.

getCommitRecord

ICommitRecord getCommitRecord(long timestamp)

Return the ICommitRecord for the most recent committed state whose commit timestamp is less than or equal to timestamp. This is used by a transaction to locate the committed state that is the basis for its operations.

Parameters:

timestamp - The timestamp of interest.

Returns:

The ICommitRecord for the most recent committed state whose commit timestamp is less than or equal to timestamp -or- null iff there are no ICommitRecords that satisfy the probe.