# Uses of Package
org.modeshape.jcr.spi.index.provider

- Packages that use org.modeshape.jcr.spi.index.provider
  Package | Description
  --- | ---
  org.modeshape.jcr.query | The Query API provides a mechanism for building and executing queries.
  org.modeshape.jcr.query.engine | This package contains several fully-functional query engine implementations.
  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.

- Classes in org.modeshape.jcr.spi.index.provider used by org.modeshape.jcr.query
  Class and Description
  IndexProvider A component that provides access to and manages one or more indexes.
  IndexWriter Interface used to record in the indexes the changes to content.
  IndexWriter.IndexingContext The context of a set of indexing operations, typically aligned with and part of a single transaction.

- Classes in org.modeshape.jcr.spi.index.provider used by org.modeshape.jcr.query.engine
  Class and Description
  Index A provider-specific index used by the query system to quickly provide the set of `NodeKey`s that satisfy a particular portion of a query.
  Index.Operation A potentially executable stateful operation that returns the set of nodes that satisfies the constraints supplied when the operation is `created`.
  IndexPlanner 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.
  IndexWriter Interface used to record in the indexes the changes to content.
  IndexWriter.IndexingContext The context of a set of indexing operations, typically aligned with and part of a single transaction.
  ResultWriter A writer passed by ModeShape to a `Index.Operation` instance when the query engine needs additional results for the query.

- Classes in org.modeshape.jcr.spi.index.provider used by org.modeshape.jcr.spi.index
  Class and Description
  IndexProvider A component that provides access to and manages one or more indexes.
  IndexProviderExistsException Exception used when an index provider already exists.

- Classes in org.modeshape.jcr.spi.index.provider used by org.modeshape.jcr.spi.index.provider
  Class and Description
  Index A provider-specific index used by the query system to quickly provide the set of `NodeKey`s that satisfy a particular portion of a query.
  Index.Operation A potentially executable stateful operation that returns the set of nodes that satisfies the constraints supplied when the operation is `created`.
  IndexFilter The filter containing a set of constraints.
  IndexPlanner 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.
  IndexWriter Interface used to record in the indexes the changes to content.
  IndexWriter.IndexingContext The context of a set of indexing operations, typically aligned with and part of a single transaction.
  ResultWriter A writer passed by ModeShape to a `Index.Operation` instance when the query engine needs additional results for the query.

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.