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

- Packages that use org.modeshape.jcr.spi.index.provider
  Package | Description
  --- | ---
  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.provider used by org.modeshape.jcr.index.local
  Class and Description
  Filter A simple filter that takes constraints as input and returns a results object that lazily returns (in batches) those nodes that satisfy the 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.
  IndexProvider A component that provides access to and manages a set of `indexes` that are described/defined with `IndexDefinition` objects via the session's `IndexManager`.
  ManagedIndex The top-level interface for an index owned by a provider, with common methods needed by indexes regardless of number of columns.

- 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 a set of `indexes` that are described/defined with `IndexDefinition` objects via the session's `IndexManager`.

- Classes in org.modeshape.jcr.spi.index.provider used by org.modeshape.jcr.query.engine
  Class and Description
  Filter.Results The results of a `Filter.filter(IndexConstraints)` operation that contains the nodes that satisfy the `supplied 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.

- Classes in org.modeshape.jcr.spi.index.provider used by org.modeshape.jcr.spi.index
  Class and Description
  Filter A simple filter that takes constraints as input and returns a results object that lazily returns (in batches) those nodes that satisfy the constraints.
  IndexProvider A component that provides access to and manages a set of `indexes` that are described/defined with `IndexDefinition` objects via the session's `IndexManager`.
  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
  Filter A simple filter that takes constraints as input and returns a results object that lazily returns (in batches) those nodes that satisfy the constraints.
  Filter.Results The results of a `Filter.filter(IndexConstraints)` operation that contains the nodes that satisfy the `supplied constraints`.
  IndexChangeAdapter
  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.
  ManagedIndex The top-level interface for an index owned by a provider, with common methods needed by indexes regardless of number of columns.

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