com.bigdata.journal

Interface IGISTLocalManager

All Superinterfaces:

IGISTManager

All Known Subinterfaces:

IBTreeManager, IHAJournal, IJournal

All Known Implementing Classes:

AbstractJournal, Journal, JournalDelegate, StoreManager.ManagedJournal, TemporaryStore

public interface IGISTLocalManager
extends IGISTManager

Interface for managing local (non-distributed) generalized search trees (GiST).

Author:

Bryan Thompson

See Also:

GIST

Method Summary

Methods

Modifier and Type	Method and Description
ICheckpointProtocol	getIndexLocal(String name, long commitTime) Core implementation for access to historical index views.
ICheckpointProtocol	getUnisolatedIndex(String name) Return the mutable view of the named persistence capable data structure (aka the "live" or ITx.UNISOLATED view).
ICheckpointProtocol	register(String name, IndexMetadata metadata) Method creates and registers a named persistence capable data structure.

Methods inherited from interface com.bigdata.journal.IGISTManager

dropIndex, indexNameScan, registerIndex

Method Detail

register

ICheckpointProtocol register(String name,
                           IndexMetadata metadata)

Method creates and registers a named persistence capable data structure.

Parameters:

name - The name of the index.

metadata - The metadata that describes the data structure to be created.

Returns:

The persistence capable data structure.

See Also:

IGISTManager.registerIndex(IndexMetadata), Checkpoint.create(IRawStore, IndexMetadata)

getUnisolatedIndex

ICheckpointProtocol getUnisolatedIndex(String name)

Return the mutable view of the named persistence capable data structure (aka the "live" or ITx.UNISOLATED view).

Note: IIndexManager#getIndex(String) delegates to this method and then casts the result to an IIndex. This is the core implementation to access an existing named index.

Returns:

The mutable view of the persistence capable data structure.

See Also:

IIndexManager#getIndex(String), GIST

getIndexLocal

ICheckpointProtocol getIndexLocal(String name,
                                long commitTime)

Core implementation for access to historical index views.

Note: Transactions should pass in the timestamp against which they are reading rather than the transaction identifier (aka startTime). By providing the timestamp of the commit point, the transaction will hit the index cache on the journal. If the transaction passes the startTime instead, then all startTimes will be different and the cache will be defeated.

Throws:

UnsupportedOperationException - If you pass in ITx.UNISOLATED, ITx.READ_COMMITTED, or a timestamp that corresponds to a read-write transaction since those are not "commit times".

See Also:

IIndexStore#getIndex(String, long), Add cache for access to historical index views on the Journal by name and commitTime. , GIST FIXME GIST : Reconcile with {@link IResourceManager#getIndex(String, long)}. They are returning types that do not overlap ({@link ICheckpointProtocol} and {@link ILocalBTreeView}). This is blocking the support of GIST in {@link AbstractTask}.