org.modeshape.jcr.index.lucene

Class LuceneIndexProvider

java.lang.Object

org.modeshape.jcr.spi.index.provider.IndexProvider

org.modeshape.jcr.index.lucene.LuceneIndexProvider

public class LuceneIndexProvider
extends IndexProvider

IndexProvider implementation which uses the Apache Lucene library.

Since:

4.5

Nested Class Summary

Nested classes/interfaces inherited from class org.modeshape.jcr.spi.index.provider.IndexProvider

IndexProvider.ManagedIndexOperation

Field Summary

Fields inherited from class org.modeshape.jcr.spi.index.provider.IndexProvider

DEFAULT_BATCH_SIZE

Constructor Summary

Constructors

Constructor and Description
LuceneIndexProvider()

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize() Method that should do the provider-specific initialization work.
protected IndexUsage	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 int	getCostEstimate() Returns a positive number representing the cost estimate of using indexes from this provider.
protected ManagedIndexBuilder	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.
Long	getLatestIndexUpdateTime() Return the latest time at which this provider successfully updated its indexes.
void	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.

Methods inherited from class org.modeshape.jcr.spi.index.provider.IndexProvider

batchSize, context, createIndex, environment, getIndex, getIndexes, getIndexNames, getIndexPlanner, getIndexWriter, getManagedIndex, getName, getRepositoryName, initialize, isType, logger, matches, matches, names, namespaces, notify, notify, notify, onEachIndex, onEachIndexInWorkspace, planUseOfIndex, postShutdown, preShutdown, removeIndex, shutdown, updateIndex, validateDefaultColumnDefinitionType, validateDefaultColumnTypes, valueFactories

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LuceneIndexProvider

public LuceneIndexProvider()

Method Detail

doInitialize

protected void doInitialize()
                     throws RepositoryException

Description copied from class: IndexProvider

Method that should do the provider-specific initialization work. This is called by ModeShape once each time the repository is started; this method should not be called by the provider itself.

By the time this method is called, ModeShape will hav already set the IndexProvider.context, IndexProvider.logger, IndexProvider.name, and IndexProvider.repositoryName plus any fields that match configuration properties for the provider.

This is an excellent place for providers to validate the provider-specific fields set by ModeShape via reflection during instantiation.

Specified by:

doInitialize in class IndexProvider

Throws:

RepositoryException - if there is a problem initializing the provider

validateProposedIndex

public void validateProposedIndex(ExecutionContext context,
                                  IndexDefinition defn,
                                  NodeTypes.Supplier nodeTypesSupplier,
                                  Problems problems)

Description copied from class: IndexProvider

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.

This should only be implemented if the provider has any particular validation requirements (for example it doesn't support multiple columns or certain index types). The repository will perform for all index definitions some basic validations via IndexProvider.validateDefaultColumnTypes(ExecutionContext, IndexDefinition, Problems)

Overrides:

validateProposedIndex in class IndexProvider

Parameters:

context - the execution context in which to perform the validation; never null

defn - the proposed index definition; never null

nodeTypesSupplier - the supplier for the NodeTypes object that contains information about the currently-registered node types; never null

problems - the problems that should be used to report any issues with the index definition; never null

getCostEstimate

protected int getCostEstimate()

Description copied from class: IndexProvider

Returns a positive number representing the cost estimate of using indexes from this provider. The cost estimate is a relative measure of how fast/complex the indexes of a provider are which should also take into account whether a provider is local to the repository or not. Remote providers should always return a higher cost than local providers.

Overrides:

getCostEstimate in class IndexProvider

Returns:

a positive integer

See Also:

IndexCostCalculator.Costs

getLatestIndexUpdateTime

public Long getLatestIndexUpdateTime()

Description copied from class: IndexProvider

Return the latest time at which this provider successfully updated its indexes.

Overrides:

getLatestIndexUpdateTime in class IndexProvider

Returns:

a Long instance which either contains the latest update time or null which means that this provider does not support incremental reindexing.

getIndexBuilder

protected ManagedIndexBuilder getIndexBuilder(IndexDefinition defn,
                                              String workspaceName,
                                              NodeTypes.Supplier nodeTypesSupplier,
                                              ChangeSetAdapter.NodeTypePredicate matcher)

Description copied from class: IndexProvider

Offers subclasses the possibility of providing a ManagedIndexBuilder instance which significantly simplifies the task of creating or updating ManagedIndex instances for providers.

If a provider chooses to override this method, it does not have to override the #createIndex(IndexDefinition, String, NodeTypes.Supplier, NodeTypePredicate, IndexFeedback) method or the #updateIndex(IndexDefinition, IndexDefinition, ManagedIndex, String, NodeTypes.Supplier, NodeTypePredicate, IndexFeedback) method, as the builder instance will be used to create specific indexes and adapters, based on the index definition.

Providers can also choose to ignore this method, in which case they will have to override the #createIndex(IndexDefinition, String, NodeTypes.Supplier, NodeTypePredicate, IndexFeedback) and #updateIndex(IndexDefinition, IndexDefinition, ManagedIndex, String, NodeTypes.Supplier, NodeTypePredicate, IndexFeedback) methods.

Overrides:

getIndexBuilder in class IndexProvider

Parameters:

defn - the definition of the index; never null

workspaceName - the name of the actual workspace to which the new index applies; never null

nodeTypesSupplier - the supplier for the current node types cache; never null

matcher - the node type matcher used to determine which nodes should be included in the index, and which automatically updates when node types are changed in the repository; may not be null

Returns:

a ManagedIndexBuilder instance, or null (the default) which indicates that a provider chooses to ovveride both the createIndex and updateIndex methods.

evaluateUsage

protected IndexUsage evaluateUsage(QueryContext context,
                                   IndexCostCalculator calculator,
                                   IndexDefinition defn)

Description copied from class: IndexProvider

Returns an object which is used during the planning phase to evaluate if a certain index should be used or not.

Overrides:

evaluateUsage in class IndexProvider

Parameters:

context - the context of the original query; never null

calculator - the calculator that should be used to record plan information for the index; never null

defn - the definition for the index; never null

Returns:

an IndexUsage instance, or null which is the default and which indicates that a provider chooses to override the IndexProvider.planUseOfIndex(QueryContext, IndexCostCalculator, String, ManagedIndex, IndexDefinition) method

See Also:

IndexProvider.planUseOfIndex(QueryContext, IndexCostCalculator, String, ManagedIndex, IndexDefinition)