Package | Description |
---|---|
org.modeshape.jcr | |
org.modeshape.jcr.api.index | |
org.modeshape.jcr.index.elasticsearch | |
org.modeshape.jcr.index.local | |
org.modeshape.jcr.index.lucene | |
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,
Set<String> indexNames)
Read from system storage the index definitions.
|
Modifier and Type | Method and Description |
---|---|
void |
SystemContent.remove(IndexDefinition indexDefn) |
protected 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 | Method and Description |
---|---|
protected ProvidedIndex<?> |
EsManagedIndexBuilder.buildEnumeratedIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected ProvidedIndex<?> |
EsManagedIndexBuilder.buildMultiValueIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected ProvidedIndex<?> |
EsManagedIndexBuilder.buildNodeTypeIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected ProvidedIndex<?> |
EsManagedIndexBuilder.buildTextIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected ProvidedIndex<?> |
EsManagedIndexBuilder.buildUniqueValueIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
static EsManagedIndexBuilder |
EsManagedIndexBuilder.create(EsClient client,
ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier,
String workspaceName,
ChangeSetAdapter.NodeTypePredicate matcher)
Create a builder for the supplied index definition.
|
protected IndexUsage |
EsIndexProvider.evaluateUsage(QueryContext context,
IndexCostCalculator calculator,
IndexDefinition defn) |
protected ManagedIndexBuilder |
EsIndexProvider.getIndexBuilder(IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected static void |
EsManagedIndexBuilder.validate(IndexDefinition defn,
Problems problems)
Validate whether the index definition is acceptable for this provider.
|
void |
EsIndexProvider.validateProposedIndex(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypeSupplier,
Problems problems) |
Constructor and Description |
---|
EsIndex(EsClient client,
ExecutionContext context,
IndexDefinition defn,
String workspace)
Creates new index.
|
EsIndexColumns(ExecutionContext context,
IndexDefinition defn)
Creates new set of columns using index definition.
|
EsManagedIndexBuilder(EsClient client,
ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier,
String workspaceName,
ChangeSetAdapter.NodeTypePredicate matcher) |
Modifier and Type | Method and Description |
---|---|
protected ProvidedIndex<?> |
LocalIndexBuilder.SingleColumnIndexBuilder.buildEnumeratedIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected ProvidedIndex<?> |
LocalIndexBuilder.SingleColumnIndexBuilder.buildMultiValueIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected ProvidedIndex<?> |
LocalIndexBuilder.SingleColumnIndexBuilder.buildNodeTypeIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected ProvidedIndex<?> |
LocalIndexBuilder.SingleColumnIndexBuilder.buildTextIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected ProvidedIndex<?> |
LocalIndexBuilder.SingleColumnIndexBuilder.buildUniqueValueIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
static <T> LocalIndexBuilder<T> |
LocalIndexBuilder.create(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier,
String workspaceName,
ChangeSetAdapter.NodeTypePredicate matcher,
org.mapdb.DB db)
Create a builder for the supplied index definition.
|
protected IndexUsage |
LocalIndexProvider.evaluateUsage(QueryContext context,
IndexCostCalculator calculator,
IndexDefinition defn) |
protected ManagedIndexBuilder |
LocalIndexProvider.getIndexBuilder(IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected static void |
LocalIndexBuilder.validate(IndexDefinition defn,
Problems problems)
Validate whether the index definition is acceptable for this provider.
|
void |
LocalIndexProvider.validateProposedIndex(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypeSupplier,
Problems problems) |
Constructor and Description |
---|
LocalIndexBuilder(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier,
String workspaceName,
ChangeSetAdapter.NodeTypePredicate matcher) |
SingleColumnIndexBuilder(ExecutionContext context,
IndexDefinition defn,
NodeTypes.Supplier nodeTypesSupplier,
String workspaceName,
ChangeSetAdapter.NodeTypePredicate matcher,
PropertyType actualPropertyType,
org.mapdb.DB db) |
Constructor and Description |
---|
LuceneManagedIndexBuilder(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher,
LuceneConfig luceneConfig) |
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 | Field and Description |
---|---|
protected IndexDefinition |
ManagedIndexBuilder.defn |
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 ProvidedIndex<?> |
ManagedIndexBuilder.buildEnumeratedIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected abstract ProvidedIndex<?> |
ManagedIndexBuilder.buildMultiValueIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected abstract ProvidedIndex<?> |
ManagedIndexBuilder.buildNodeTypeIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected abstract ProvidedIndex<?> |
ManagedIndexBuilder.buildTextIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
protected abstract ProvidedIndex<?> |
ManagedIndexBuilder.buildUniqueValueIndex(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
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.
|
protected IndexUsage |
IndexProvider.evaluateUsage(QueryContext context,
IndexCostCalculator calculator,
IndexDefinition defn)
Returns an object which is used during the planning phase to evaluate if a certain index should be used or not.
|
protected ManagedIndexBuilder |
IndexProvider.getIndexBuilder(IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher)
Offers subclasses the possibility of providing a
ManagedIndexBuilder instance which significantly simplifies the
task of creating or updating ManagedIndex instances for providers. |
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.
|
protected void |
IndexProvider.validateDefaultColumnDefinitionType(ExecutionContext context,
IndexDefinition defn,
IndexColumnDefinition columnDefn,
Problems problems) |
void |
IndexProvider.validateDefaultColumnTypes(ExecutionContext context,
IndexDefinition defn,
Problems problems)
Validates that if certain default columns are present in the index definition, they have a required type.
|
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) |
ManagedIndexBuilder(ExecutionContext context,
IndexDefinition defn,
String workspaceName,
NodeTypes.Supplier nodeTypesSupplier,
ChangeSetAdapter.NodeTypePredicate matcher) |
Copyright © 2008–2016 JBoss, a division of Red Hat. All rights reserved.