com.bigdata.journal

Interface IBTreeManager

All Superinterfaces:

ICounterSetAccess, IGISTLocalManager, IGISTManager, IIndexManager, IIndexStore

All Known Subinterfaces:

IHAJournal, IJournal

All Known Implementing Classes:

AbstractJournal, Journal, JournalDelegate, StoreManager.ManagedJournal, TemporaryStore

public interface IBTreeManager
extends IIndexManager, IGISTLocalManager

Interface for management of local index resources such as BTree, HTree, etc. TODO GIST This interface was historically only for the local BTree. The GIST support has been pushed down into the IGISTLocalManager. The BTree and IIndex specific methods on this interface are a mixture of convenience and support for scale-out and should eventually be phased out of this interface. The interface itself could be renamed to something along the lines of "IIndexLocalManager".

Author:

Bryan Thompson

See Also:

GIST

Method Summary

Methods

Modifier and Type	Method and Description
IIndex	getIndex(String name) Return the unisolated view of the named index (the mutable view of the live index object).
IIndex	registerIndex(String name, BTree btree) Register a named index.
IIndex	registerIndex(String name, IndexMetadata indexMetadata) Register a named index.

Methods inherited from interface com.bigdata.journal.IIndexManager

getIndex, isGroupCommit

Methods inherited from interface com.bigdata.journal.IIndexStore

addScheduledTask, destroy, getCollectPlatformStatistics, getCollectQueueStatistics, getExecutorService, getGlobalFileSystem, getGlobalRowStore, getGlobalRowStore, getHttpdPort, getLastCommitTime, getResourceLocator, getResourceLockService, getTempStore

Methods inherited from interface com.bigdata.counters.ICounterSetAccess

getCounters

Methods inherited from interface com.bigdata.journal.IGISTLocalManager

getIndexLocal, getUnisolatedIndex, register

Methods inherited from interface com.bigdata.journal.IGISTManager

dropIndex, indexNameScan, registerIndex

Method Detail

registerIndex

IIndex registerIndex(String name,
                   BTree btree)

Register a named index.

Parameters:

name - The name that can be used to recover the index.

btree - The btree.

Returns:

The object that would be returned by getIndex(String).

Throws:

IndexExistsException - if there is an index already registered under that name.

See Also:

IGISTManager.registerIndex(IndexMetadata), IIndexManager.getIndex(String, long), IGISTLocalManager.getIndexLocal(String, long)

registerIndex

IIndex registerIndex(String name,
                   IndexMetadata indexMetadata)

Register a named index.

This variant allows you to register an index under a name other than the value returned by IndexMetadata.getName().

Note: This variant is generally by the IMetadataService when it needs to register a index partition of some scale-out index on a IDataService. In this case the name is the name of the index partition while the value reported by IndexMetadata.getName() is the name of the scale-out index. In nearly all other cases you can use IGISTManager.registerIndex(IndexMetadata) instead. The same method signature is also declared by IDataService.registerIndex(String, IndexMetadata) in order to support registration of index partitions.

Note: Due to the method signature, this method CAN NOT be used to create and register persistence capable data structures other than an IIndex (aka B+Tree).

Parameters:

name - The name that can be used to recover the index.

indexMetadata - The metadata describing the index.

Returns:

The object that would be returned by getIndex(String).

Throws:

IndexExistsException - if there is an index already registered under that name.

See Also:

IIndexManager.getIndex(String, long), FIXME GIST Due to the method signature, this method CAN NOT be used to create and register persistence capable data structures other than an {@link IIndex} (aka B+Tree). It is difficult to reconcile this method with other method signatures since this method is designed for scale-out and relies on {@link IIndex}. However, only the B+Tree is an {@link IIndex}. Therefore, this method signature can not be readily reconciled with the {@link HTree}. The only interface which the {@link BTree} and {@link HTree} share is the {@link ICheckpointProtocol} interface, but that is a purely local (not remote) interface and is therefore not suitable to scale-out. Also, it is only in scale-out where the returned object can be a different type than the simple {@link BTree} class, e.g., a {@link FusedView} or even an {@link IClientIndex}.

getIndex

IIndex getIndex(String name)

Return the unisolated view of the named index (the mutable view of the live index object).

Parameters:

name - The name of the index.

Returns:

The unisolated view named index or null iff there is no index registered with that name.

Throws:

IllegalArgumentException - if name is null