com.bigdata.journal
Interface IIndexManager

All Superinterfaces:

IIndexStore

All Known Subinterfaces:

IBigdataFederation<T>, IBTreeManager, IJournal

All Known Implementing Classes:

AbstractDistributedFederation, AbstractFederation, AbstractJournal, AbstractScaleOutFederation, JiniFederation, Journal, JournalDelegate, StoreManager.ManagedJournal, TemporaryStore

public interface IIndexManager
extends IIndexStore

Interface for managing named indices.

Version:

$Id: IIndexManager.java 2265 2009-10-26 12:51:06Z thompsonbry $

Author:

Bryan Thompson

Method Summary

void	dropIndex(String name) Drops the named index.
void	registerIndex(IndexMetadata indexMetadata) Register a named index.

Methods inherited from interface com.bigdata.journal.IIndexStore

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

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(). Use IIndexStore#getIndex(String) to test whether there is an index registered under a given name.

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.