com.bigdata.journal

Interface IGISTManager

All Known Subinterfaces:

IBigdataFederation<T>, IBTreeManager, IGISTLocalManager, IHAJournal, IIndexManager, IJournal

All Known Implementing Classes:

AbstractDistributedFederation, AbstractFederation, AbstractJournal, AbstractResourceManagerTestCase.MockFederation, AbstractScaleOutFederation, EmbeddedFederation, Journal, JournalDelegate, StoreManager.ManagedJournal, TemporaryStore

public interface IGISTManager

Interface for managing local or distributed index structures in a manner that is not B+Tree specific. These methods are thus GIST compatible, but that does not guarantee distributed support for all GIST data structures.

Author:

Bryan Thompson

See Also:

GIST

Method Summary

Methods

Modifier and Type	Method and Description
void	dropIndex(String name) Drops the named index.
Iterator<String>	indexNameScan(String prefix, long timestamp) Iterator visits the names of all indices spanned by the given prefix.
void	registerIndex(IndexMetadata indexMetadata) Register a named index.

Method Detail

registerIndex

void registerIndex(IndexMetadata indexMetadata)

Register a named index.

Note: The name property MUST be set on the IndexMetadata and the index will be registered under that name.

Parameters:

indexMetadata - The metadata describing the index.

Throws:

IllegalArgumentException - if the argument is null.

IllegalArgumentException - if the name argument was not specified when the IndexMetadata was created.

IndexExistsException - if there is an index already registered under the name returned by IndexMetadata.getName().

See Also:

IGISTLocalManager.getIndexLocal(String, long)

dropIndex

void dropIndex(String name)

Drops the named index.

Note: Whether or not and when index resources are reclaimed is dependent on the store. For example, an immortal store will retain all historical states for all indices. Likewise, a store that uses index partitions may be able to delete index segments immediately.

Parameters:

name - The name of the index to be dropped.

Throws:

NoSuchIndexException - if name does not identify a registered index.

indexNameScan

Iterator<String> indexNameScan(String prefix,
                             long timestamp)

Iterator visits the names of all indices spanned by the given prefix.

Parameters:

prefix - The prefix (optional). When given, this MUST include a . if you want to restrict the scan to only those indices in a given namespace. Otherwise you can find indices in kb2 if you provide the prefix kb where both kb and kb2 are namespaces since the indices spanned by kb would include both kb.xyz and kb2.xyx.

timestamp - A timestamp which represents either a possible commit time on the store or a read-only transaction identifier.

Returns:

An iterator visiting those index names.