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

- Packages that use org.modeshape.jcr.spi.index
  Package | Description
  --- | ---
  org.modeshape.jcr |
  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
  IndexColumnDefinition An immutable definition of a column used in an `IndexDefinition`.
  IndexDefinition An immutable description of an index definition.
  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.query
  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.query.engine
  Class and 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.
  IndexDefinition An immutable description of an index definition.
  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.spi.index
  Class and Description
  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.
  IndexDefinition.IndexKind The kind of indexes.
  IndexDefinitionTemplate A mutable form of the `IndexDefinition`.
  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.

- Classes in org.modeshape.jcr.spi.index used by org.modeshape.jcr.spi.index.provider
  Class and 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.
  IndexDefinition An immutable description of an index definition.
  IndexDefinitionChanges A description of the changes to `IndexDefinition`s.

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