public interface IndexManager
Modifier and Type | Method and Description |
---|---|
IndexColumnDefinitionTemplate |
createIndexColumnDefinitionTemplate()
Create a new template that can be used to programmatically define a column on an index.
|
IndexDefinitionTemplate |
createIndexDefinitionTemplate()
Create a new template that can be used to programmatically define an index.
|
Map<String,IndexDefinition> |
getIndexDefinitions()
Get a map of the registered index definitions keyed by their names.
|
IndexProvider |
getProvider(String name)
Get the query index provider registered with the given name.
|
Set<String> |
getProviderNames()
Get the names of the registered
IndexProvider s. |
void |
register(IndexProvider provider)
Register a new already-instantiated
IndexProvider . |
void |
registerIndex(IndexDefinition indexDefinition,
boolean allowUpdate)
Register a new definition for an index.
|
void |
registerIndexes(IndexDefinition[] indexDefinitions,
boolean allowUpdate)
Register new definitions for several indexes.
|
void |
unregister(String providerName)
Unregister the
IndexProvider with the supplied name. |
void |
unregisterIndex(String indexName)
Removes an existing index definition.
|
Set<String> getProviderNames()
IndexProvider
s.IndexProvider getProvider(String name)
name
- the name of the query index provider; may not be nullMap<String,IndexDefinition> getIndexDefinitions()
void register(IndexProvider provider) throws IndexProviderExistsException, RepositoryException
IndexProvider
.provider
- the new provider instance; may not be nullIndexProviderExistsException
- if there is already an existing index provider with the same nameRepositoryException
- if there is a problem registering the providervoid unregister(String providerName) throws NoSuchProviderException, RepositoryException
IndexProvider
with the supplied name.providerName
- the name of the query index provider; may not be nullNoSuchProviderException
- there is no index provider with the supplied nameRepositoryException
- if there is a problem unregistering the providervoid registerIndex(IndexDefinition indexDefinition, boolean allowUpdate) throws InvalidIndexDefinitionException, IndexExistsException, RepositoryException
indexDefinition
- the definition; may not be nullallowUpdate
- true if the definition can update or ovewrite an existing definition with the same name, or false if
calling this method when a definition with the same name already exists should result in an exceptionInvalidIndexDefinitionException
- if the new definition is invalidIndexExistsException
- if allowUpdate
is false
and the NodeTypeDefinition
specifies a node type name that is already registered.RepositoryException
- if there is a problem registering the new definition, or if an existing indexvoid registerIndexes(IndexDefinition[] indexDefinitions, boolean allowUpdate) throws InvalidIndexDefinitionException, IndexExistsException, RepositoryException
indexDefinitions
- the definitions; may not be nullallowUpdate
- true if each of the definition can update or ovewrite an existing definition with the same name, or
false if calling this method when a definition with the same name already exists should result in an exceptionInvalidIndexDefinitionException
- if the new definition is invalidIndexExistsException
- if allowUpdate
is false
and the NodeTypeDefinition
specifies a node type name that is already registered.RepositoryException
- if there is a problem registering the new definition, or if an existing indexvoid unregisterIndex(String indexName) throws NoSuchIndexException, RepositoryException
indexName
- the name of the index definition to be removed; may not be nullNoSuchIndexException
- there is no index with the supplied nameRepositoryException
- if there is a problem registering the new definition, or if an existing indexIndexDefinitionTemplate createIndexDefinitionTemplate()
IndexColumnDefinitionTemplate createIndexColumnDefinitionTemplate()
Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.