## Uses of Class
org.modeshape.jcr.spi.index.provider.IndexPlanner

- Packages that use IndexPlanner
  Package | Description
  --- | ---
  org.modeshape.jcr.index.local |
  org.modeshape.jcr.query.engine | This package contains several fully-functional query engine implementations.
  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.

- - ### Uses of IndexPlanner in org.modeshape.jcr.index.local

    Methods in org.modeshape.jcr.index.local that return IndexPlanner
    Modifier and Type | Method and Description
    --- | ---
    `IndexPlanner` | LocalIndexProvider.`getIndexPlanner()`

  - ### Uses of IndexPlanner in org.modeshape.jcr.query.engine

    Subclasses of IndexPlanner in org.modeshape.jcr.query.engine
    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `IndexQueryEngine.ProviderIndexPlanner` A `IndexPlanner` implementation that passes through only those indexes that are owned by the named provider.

    Method parameters in org.modeshape.jcr.query.engine with type arguments of type IndexPlanner
    Modifier and Type | Method and Description
    --- | ---
    `static IndexPlanners` | IndexPlanners.`withProviders(Map<String,IndexPlanner> plannersByProviderName)` Get an IndexPlanners instance that looks for the implicit (built-in) indexes and that calls the appropriate `IndexPlanner` instances given the available indexes for this selector.

    Constructors in org.modeshape.jcr.query.engine with parameters of type IndexPlanner
    Constructor and Description
    `IndexQueryEngine.ProviderIndexPlanner(String providerName, IndexPlanner providerPlanner)`

  - ### Uses of IndexPlanner in org.modeshape.jcr.spi.index.provider

    Methods in org.modeshape.jcr.spi.index.provider that return IndexPlanner
    Modifier and Type | Method and Description
    --- | ---
    `static IndexPlanner` | IndexPlanner.`both(IndexPlanner planner1, IndexPlanner planner2)` Utility that returns an `IndexPlanner` implementation that delegates to the first planner and then to the second planner.
    `abstract IndexPlanner` | IndexProvider.`getIndexPlanner()` Get the planner that, during the query planning/optimization phase, evaluates for a single source the AND-ed query constraints and defines indexes that may be used.

    Methods in org.modeshape.jcr.spi.index.provider with parameters of type IndexPlanner
    Modifier and Type | Method and Description
    --- | ---
    `static IndexPlanner` | IndexPlanner.`both(IndexPlanner planner1, IndexPlanner planner2)` Utility that returns an `IndexPlanner` implementation that delegates to the first planner and then to the second planner.

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