Package | Description |
---|---|
org.modeshape.jcr.spi.index |
This package contains the interfaces for managing index providers and index definitions.
|
org.modeshape.jcr.spi.index.provider |
This package contains the Service Provider Interface (SPI) for custom index providers, which are components that encapsulate
how ModeShape updates and uses a set of particular indexes.
|
Modifier and Type | Method and Description |
---|---|
List<ManagedIndex> |
IndexManager.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. |
Modifier and Type | Class and Description |
---|---|
class |
DefaultManagedIndex
A
ManagedIndex implementation which wraps an index instance created by a particular provider, offering
a default implementation for some index-related operations. |
Modifier and Type | Method and Description |
---|---|
ManagedIndex |
ManagedIndexBuilder.build()
Creates a new managed index which wraps a provider-specific index plus a change adapter.
|
protected ManagedIndex |
IndexProvider.createIndex(IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher,
IndexFeedback feedback)
Method called when this provider needs to create a new index given the unique pair of workspace name and index definition.
|
ManagedIndex |
IndexProvider.getManagedIndex(String indexName,
String workspaceName)
Get the managed index with the given name and applicable for the given workspace.
|
protected ManagedIndex |
IndexProvider.updateIndex(IndexDefinition oldDefn,
IndexDefinition updatedDefn,
ManagedIndex existingIndex,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher,
IndexFeedback feedback)
Method called when this provider needs to update an existing index given the unique pair of workspace name and index
definition.
|
Modifier and Type | Method and Description |
---|---|
protected Iterable<ManagedIndex> |
IndexProvider.getIndexes(String workspaceName)
Get this provider's
ManagedIndex instances for the given workspace. |
Modifier and Type | Method and Description |
---|---|
void |
IndexProvider.ManagedIndexOperation.apply(String workspaceName,
ManagedIndex index,
IndexDefinition defn)
Apply the operation to a managed index
|
protected void |
IndexProvider.planUseOfIndex(QueryContext context,
IndexCostCalculator calculator,
String workspaceName,
ManagedIndex index,
IndexDefinition defn)
The method that is called by the IndexProvider's
default IndexPlanner for each
managed index in the given workspace. |
protected void |
IndexProvider.removeIndex(IndexDefinition oldDefn,
ManagedIndex existingIndex,
String workspaceName)
Method called when this provider needs to remove an existing index given the unique pair of workspace name and index
definition.
|
protected ManagedIndex |
IndexProvider.updateIndex(IndexDefinition oldDefn,
IndexDefinition updatedDefn,
ManagedIndex existingIndex,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher,
IndexFeedback feedback)
Method called when this provider needs to update an existing index given the unique pair of workspace name and index
definition.
|
Copyright © 2008–2016 JBoss, a division of Red Hat. All rights reserved.