org.modeshape.jcr.spi.index

Interface IndexManager

All Superinterfaces:

IndexManager

public interface IndexManager
extends IndexManager

An interface for programmatically adding or removing index providers and index definitions.

Nested Class Summary

Nested classes/interfaces inherited from interface org.modeshape.jcr.api.index.IndexManager

IndexManager.IndexStatus

Method Summary

Methods

Modifier and Type	Method and Description
List<ManagedIndex>	getIndexes(String providerName, String workspaceName, IndexManager.IndexStatus status) Returns a list of ManagedIndex instances for a given provider and workspace, which have a certain status.
IndexProvider	getProvider(String name) Get the query index provider registered with the given name.
void	register(IndexProvider provider) Register a new already-instantiated IndexProvider.
void	unregister(String providerName) Unregister the IndexProvider with the supplied name.

Methods inherited from interface org.modeshape.jcr.api.index.IndexManager

createIndexColumnDefinitionTemplate, createIndexDefinitionTemplate, getIndexDefinitions, getIndexNames, getIndexStatus, getProviderNames, registerIndex, registerIndexes, unregisterIndexes

Method Detail

getProvider

IndexProvider getProvider(String name)

Get the query index provider registered with the given name.

Parameters:

name - the name of the query index provider; may not be null

Returns:

the query index provider instance, or null if there is no provider registered with the supplied name

register

void register(IndexProvider provider)
              throws IndexProviderExistsException,
                     javax.jcr.RepositoryException

Register a new already-instantiated IndexProvider.

Parameters:

provider - the new provider instance; may not be null

Throws:

IndexProviderExistsException - if there is already an existing index provider with the same name

javax.jcr.RepositoryException - if there is a problem registering the provider

unregister

void unregister(String providerName)
                throws NoSuchProviderException,
                       javax.jcr.RepositoryException

Unregister the IndexProvider with the supplied name.

Parameters:

providerName - the name of the query index provider; may not be null

Throws:

NoSuchProviderException - there is no index provider with the supplied name

javax.jcr.RepositoryException - if there is a problem unregistering the provider

getIndexes

List<ManagedIndex> getIndexes(String providerName,
                            String workspaceName,
                            IndexManager.IndexStatus status)

Returns a list of ManagedIndex instances for a given provider and workspace, which have a certain status.

Parameters:

providerName - a String the name of an index provider, may not be null

workspaceName - a String the name of a workspace, may not be null

status - a IndexManager.IndexStatus instance, may not be null

Returns:

a List of ManagedIndex instances, never null