Package | Description |
---|---|
org.modeshape.jcr | |
org.modeshape.jcr.api.index | |
org.modeshape.jcr.index.local | |
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 |
---|---|
IndexDefinition |
RepositoryConfiguration.Indexes.getIndex(String name) |
IndexDefinition |
SystemContent.readIndexDefinition(CachedNode indexDefn,
Name providerName) |
Modifier and Type | Method and Description |
---|---|
abstract Map<String,IndexDefinition> |
RepositoryIndexes.getIndexDefinitions()
Get a map of the registered index definitions keyed by their names.
|
abstract Iterable<IndexDefinition> |
RepositoryIndexes.indexesFor(String nodeTypeName,
String providerName)
Get all of the index definitions that deal with properties on the node type with the given name.
|
List<IndexDefinition> |
SystemContent.readAllIndexDefinitions(Set<String> providerNames)
Read from system storage the index definitions.
|
Modifier and Type | Method and Description |
---|---|
void |
SystemContent.remove(IndexDefinition indexDefn) |
void |
SystemContent.store(IndexDefinition indexDefn,
boolean updateExisting) |
Modifier and Type | Interface and Description |
---|---|
interface |
IndexDefinitionTemplate
A mutable form of the
IndexDefinition . |
Modifier and Type | Method and Description |
---|---|
Map<String,IndexDefinition> |
IndexManager.getIndexDefinitions()
Get a map of the registered index definitions keyed by their names.
|
Modifier and Type | Method and Description |
---|---|
void |
IndexManager.registerIndex(IndexDefinition indexDefinition,
boolean allowUpdate)
Register a new definition for an index.
|
void |
IndexManager.registerIndexes(IndexDefinition[] indexDefinitions,
boolean allowUpdate)
Register new definitions for several indexes.
|
Modifier and Type | Field and Description |
---|---|
protected IndexDefinition |
ManagedLocalIndexBuilder.defn |
Modifier and Type | Method and Description |
---|---|
static <T> ManagedLocalIndexBuilder<T> |
ManagedLocalIndexBuilder.create(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier)
Create a builder for the supplied index definition.
|
protected ManagedIndex |
LocalIndexProvider.createIndex(IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
IndexFeedback feedback) |
protected void |
LocalIndexProvider.planUseOfIndex(QueryContext context,
IndexCostCalculator calculator,
String workspaceName,
ManagedIndex index,
IndexDefinition defn) |
protected void |
LocalIndexProvider.removeIndex(IndexDefinition oldDefn,
ManagedIndex existingIndex,
String workspaceName) |
protected ManagedIndex |
LocalIndexProvider.updateIndex(IndexDefinition oldDefn,
IndexDefinition updatedDefn,
ManagedIndex existingIndex,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
IndexFeedback feedback) |
void |
LocalIndexProvider.validateProposedIndex(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypeSupplier,
Problems problems) |
Constructor and Description |
---|
ManagedLocalIndexBuilder.SingleColumnIndexBuilder(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier,
PropertyType actualPropertyType) |
ManagedLocalIndexBuilder(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier) |
Modifier and Type | Method and Description |
---|---|
Collection<IndexDefinition> |
WorkspaceChanges.getIndexDefinitions()
Get the
IndexDefinition s. |
Map<String,IndexDefinition> |
IndexDefinitionChanges.getUpdatedIndexDefinitions()
Get the
IndexDefinition s that were added or updated. |
Modifier and Type | Method and Description |
---|---|
static ChangeSetListener |
IndexChangeSetListeners.create(ExecutionContext context,
NodeTypes.Supplier nodeTypesSupplier,
IndexDefinition indexDefinition,
IndexChangeSetListeners.MultiColumnIndexOperations operations)
Create a new ChangeSetListener implementation that can update multi-column indexes.
|
static ChangeSetListener |
IndexChangeSetListeners.create(ExecutionContext context,
NodeTypes.Supplier nodeTypesSupplier,
IndexDefinition indexDefinition,
IndexChangeSetListeners.SingleColumnIndexOperations operations)
Create a new ChangeSetListener implementation that can update single-column indexes.
|
Modifier and Type | Method and Description |
---|---|
void |
IndexProvider.ManagedIndexOperation.apply(String workspaceName,
ManagedIndex index,
IndexDefinition defn)
Apply the operation to a managed index
|
protected abstract ManagedIndex |
IndexProvider.createIndex(IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
IndexFeedback feedback)
Method called when this provider needs to create a new index given the unique pair of workspace name and index definition.
|
protected abstract 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 abstract 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 abstract ManagedIndex |
IndexProvider.updateIndex(IndexDefinition oldDefn,
IndexDefinition updatedDefn,
ManagedIndex existingIndex,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
IndexFeedback feedback)
Method called when this provider needs to update an existing index given the unique pair of workspace name and index
definition.
|
abstract void |
IndexProvider.validateProposedIndex(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier,
Problems problems)
Validate the proposed index definition, and use the supplied problems to report any issues that will prevent this provider
from creating and using an index with the given definition.
|
Constructor and Description |
---|
IndexUsage(QueryContext context,
IndexCostCalculator calculator,
IndexDefinition defn) |
Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.