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

- Packages that use org.modeshape.jcr.spi.index
  Package | Description
  --- | ---
  org.modeshape.jcr |
  org.modeshape.jcr.index.local |
  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 used by org.modeshape.jcr
  Class and Description
  IndexManager An interface for programmatically adding or removing index providers and index definitions.

- Classes in org.modeshape.jcr.spi.index used by org.modeshape.jcr.index.local
  Class and Description
  IndexConstraints The a set of constraints that ModeShape passes to `Filter` instances via the `Filter.filter(IndexConstraints)` method.
  IndexCostCalculator A collector implemented by ModeShape and supplied to the `IndexPlanner.applyIndexes(org.modeshape.jcr.query.QueryContext, org.modeshape.jcr.spi.index.IndexCostCalculator)` method so that the `IndexPlanner` can add indexes to the query plan.
  IndexFeedback A feedback mechanism to allow a `IndexProvider` to signal to ModeShape that one or more indexes need to be rebuilt.

- Classes in org.modeshape.jcr.spi.index used by org.modeshape.jcr.query
  Class and Description
  IndexManager An interface for programmatically adding or removing index providers and index definitions.
  IndexWriter Interface used to record in the indexes the changes to content.

- Classes in org.modeshape.jcr.spi.index used by org.modeshape.jcr.query.engine
  Class and Description
  Index An index used by the query system to quickly provide the set of `NodeKey`s that satisfy a particular portion of a query.
  IndexCostCalculator A collector implemented by ModeShape and supplied to the `IndexPlanner.applyIndexes(org.modeshape.jcr.query.QueryContext, org.modeshape.jcr.spi.index.IndexCostCalculator)` method so that the `IndexPlanner` can add indexes to the query plan.
  IndexManager An interface for programmatically adding or removing index providers and index definitions.
  IndexWriter Interface used to record in the indexes the changes to content.
  ResultWriter A writer passed by ModeShape to a `Filter.Results` instance when the query engine needs additional results for the query.

- Classes in org.modeshape.jcr.spi.index used by org.modeshape.jcr.spi.index
  Class and Description
  IndexChangeSetListeners.IndexChangeSetListener
  IndexChangeSetListeners.MultiColumnIndexOperations A predicate function that determines whether the changes in a specified workspace should be processed.
  IndexChangeSetListeners.SingleColumnIndexOperations A predicate function that determines whether the changes in a specified workspace should be processed.

- Classes in org.modeshape.jcr.spi.index used by org.modeshape.jcr.spi.index.provider
  Class and Description
  Index An index used by the query system to quickly provide the set of `NodeKey`s that satisfy a particular portion of a query.
  IndexConstraints The a set of constraints that ModeShape passes to `Filter` instances via the `Filter.filter(IndexConstraints)` method.
  IndexCostCalculator A collector implemented by ModeShape and supplied to the `IndexPlanner.applyIndexes(org.modeshape.jcr.query.QueryContext, org.modeshape.jcr.spi.index.IndexCostCalculator)` method so that the `IndexPlanner` can add indexes to the query plan.
  IndexDefinitionChanges A description of the changes to `IndexDefinition`s.
  IndexFeedback A feedback mechanism to allow a `IndexProvider` to signal to ModeShape that one or more indexes need to be rebuilt.
  IndexWriter Interface used to record in the indexes the changes to content.
  ResultWriter A writer passed by ModeShape to a `Filter.Results` instance when the query engine needs additional results for the query.
  WorkspaceChanges A description of the changes in workspaces applicable to `IndexDefinition`s.

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