# Package org.modeshape.jcr.spi.index

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

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  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.spi.index.IndexDefinition>, org.modeshape.jcr.spi.index.IndexCollector)` method so that the `IndexPlanner` can add indexes to the query plan.
  IndexColumnDefinition | An immutable definition of a column used in an `IndexDefinition`.
  IndexColumnDefinitionTemplate | An immutable definition of a column used in an `IndexDefinition`.
  IndexDefinition | An immutable description of an index definition.
  IndexDefinitionChanges | A description of the changes to `IndexDefinition`s.
  IndexDefinitionTemplate | A mutable form of the `IndexDefinition`.
  IndexManager | An interface for programmatically adding or removing index providers and index definitions.

- Enum Summary
  Enum | Description
  --- | ---
  IndexDefinition.IndexKind | The kind of indexes.

- Exception Summary
  Exception | Description
  --- | ---
  IndexExistsException | Exception used when an index already exists.
  InvalidIndexDefinitionException | Exception used when an index definition is invalid.
  NoSuchIndexException | Exception used when an index does not exist.

## 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.