# Package org.modeshape.jcr.spi.index

This package contains the interfaces for managing index providers and index definitions.

See: Description

- Interface Summary
  Interface | 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.
  IndexChangeSetListeners.MultiColumnIndexOperations | A predicate function that determines whether the changes in a specified workspace should be processed.
  IndexChangeSetListeners.NodeTypePredicate |
  IndexChangeSetListeners.SingleColumnIndexOperations | A predicate function that determines whether the changes in a specified workspace should be processed.
  IndexCollector | A collector implemented by ModeShape and supplied to the `IndexPlanner.applyIndexes(org.modeshape.jcr.query.QueryContext, org.modeshape.jcr.query.model.SelectorName, java.util.List<javax.jcr.query.qom.Constraint>, java.lang.Iterable<org.modeshape.jcr.api.index.IndexDefinition>, org.modeshape.jcr.spi.index.IndexCollector)` method so that the `IndexPlanner` can add indexes to the query plan.
  IndexConstraints | The a set of constraints that ModeShape passes to `Filter` instances via the `Filter.filter(IndexConstraints)` method.
  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.
  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.
  WorkspaceChanges | A description of the changes in workspaces applicable to `IndexDefinition`s.

- Class Summary
  Class | Description
  --- | ---
  IndexChangeSetListeners | A set of utilities that create `ChangeSetListener` implementations for updating indexes.
  IndexChangeSetListeners.IndexChangeSetListener |
  IndexChangeSetListeners.MultiPropertyIndexChangeSetListener |
  IndexChangeSetListeners.SinglePropertyIndexChangeSetListener |

## Package org.modeshape.jcr.spi.index Description

This package contains the interfaces for managing index providers and index definitions.

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