Package org.modeshape.jcr.spi.query

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.

See: Description

Interface Summary

Interface	Description
IndexCollector	A collector implemented by ModeShape and supplied to the QueryIndexPlanner.applyIndexes(QueryContext, SelectorName, List, IndexCollector) method so that the QueryIndexPlanner can add indexes to the query plan.
QueryIndex	A provider-specific index used by the query system to quickly provide the set of NodeKeys that satisfy a particular portion of a query.
QueryIndex.Filter	The filter containing a set of constraints.
QueryIndex.Operation	A potentially executable stateful operation that returns the set of nodes that satisfies the constraints supplied when the operation is created.
QueryIndex.ResultWriter	A writer passed by ModeShape to a QueryIndex.Operation instance when the query engine needs additional results for the query.
QueryIndexWriter	Interface used to record in the indexes the changes to content.
QueryIndexWriter.IndexingContext	The context of a set of indexing operations, typically aligned with and part of a single transaction.

Class Summary

Class	Description
QueryIndexPlanner	A provider-specific component obtained by ModeShape and then used in the planning and optimization phases of each query to identify which provider-specific indexes, if any, can be used in the processing phase to most-efficiently obtain the set of nodes that satisfies the given criteria.
QueryIndexProvider

Package org.modeshape.jcr.spi.query Description

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. To integrate your own indexing technology into ModeShape, start by create a concrete subclass of QueryIndexProvider, as well as the necessary QueryIndexWriter, QueryIndex, and QueryIndexPlanner interfaces.