## Uses of Interface
org.modeshape.jcr.spi.index.IndexDefinition

- Packages that use IndexDefinition
  Package | Description
  --- | ---
  org.modeshape.jcr |
  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.

- - ### Uses of IndexDefinition in org.modeshape.jcr

    Methods in org.modeshape.jcr that return IndexDefinition
    Modifier and Type | Method and Description
    --- | ---
    `IndexDefinition` | SystemContent.`readIndexDefinition(CachedNode indexDefn, Name providerName)`

    Methods in org.modeshape.jcr that return types with arguments of type IndexDefinition
    Modifier and Type | Method and Description
    --- | ---
    `abstract Map<String,IndexDefinition>` | RepositoryIndexes.`getIndexDefinitions()` Get a map of the registered index definitions keyed by their names.
    `abstract Iterable<IndexDefinition>` | RepositoryIndexes.`indexesFor(String nodeTypeName, String providerName)` Get all of the index definitions that deal with properties on the node type with the given name.
    `List<IndexDefinition>` | SystemContent.`readAllIndexDefinitions(Set<String> providerNames)` Read from system storage the index definitions.

    Methods in org.modeshape.jcr with parameters of type IndexDefinition
    Modifier and Type | Method and Description
    --- | ---
    `void` | SystemContent.`remove(IndexDefinition indexDefn)`
    `void` | SystemContent.`store(IndexDefinition indexDefn, boolean updateExisting)`

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

    Method parameters in org.modeshape.jcr.query.engine with type arguments of type IndexDefinition
    Modifier and Type | Method and Description
    --- | ---
    `void` | IndexQueryEngine.ProviderIndexPlanner.`applyIndexes(QueryContext context, SelectorName selector, List<Constraint> andedConstraints, Iterable<IndexDefinition> indexesOnSelector, IndexCollector indexes)`
    `void` | IndexPlan.StandardIndexPlanner.`applyIndexes(QueryContext context, SelectorName selector, List<Constraint> andedConstraints, Iterable<IndexDefinition> indexesOnSelector, IndexCollector indexes)`

  - ### Uses of IndexDefinition in org.modeshape.jcr.spi.index

    Subinterfaces of IndexDefinition in org.modeshape.jcr.spi.index
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IndexDefinitionTemplate` A mutable form of the `IndexDefinition`.

    Methods in org.modeshape.jcr.spi.index that return types with arguments of type IndexDefinition
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,IndexDefinition>` | IndexManager.`getIndexDefinitions()` Get a map of the registered index definitions keyed by their names.
    `Map<String,IndexDefinition>` | IndexDefinitionChanges.`getUpdatedIndexDefinitions()` Get the `IndexDefinition`s that were added or updated.

    Methods in org.modeshape.jcr.spi.index with parameters of type IndexDefinition
    Modifier and Type | Method and Description
    --- | ---
    `void` | IndexManager.`registerIndex(IndexDefinition indexDefinition, boolean allowUpdate)` Register a new definition for an index.
    `void` | IndexManager.`registerIndexes(IndexDefinition[] indexDefinitions, boolean allowUpdate)` Register new definitions for several indexes.

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

    Method parameters in org.modeshape.jcr.spi.index.provider with type arguments of type IndexDefinition
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | IndexPlanner.`applyIndexes(QueryContext context, SelectorName selector, List<Constraint> andedConstraints, Iterable<IndexDefinition> indexesOnSelector, IndexCollector indexes)` Examine the supplied constraints applied to the given selector in a query, and record in the supplied `IndexCollector` any and all indexes in this provider that can be used in this query.

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