## Uses of Interface
org.modeshape.jcr.spi.index.provider.ManagedIndex

- Packages that use ManagedIndex
  Package | Description
  --- | ---
  org.modeshape.jcr.index.local |
  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 ManagedIndex in org.modeshape.jcr.index.local

    Classes in org.modeshape.jcr.index.local that implement ManagedIndex
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ManagedLocalIndex`

    Methods in org.modeshape.jcr.index.local that return ManagedIndex
    Modifier and Type | Method and Description
    --- | ---
    `protected ManagedIndex` | LocalIndexProvider.`createIndex(IndexDefinition defn, String workspaceName, NodeTypes.Supplier nodeTypesSupplier, ChangeSetAdapter.NodeTypePredicate matcher, IndexFeedback feedback)`
    `protected ManagedIndex` | LocalIndexProvider.`updateIndex(IndexDefinition oldDefn, IndexDefinition updatedDefn, ManagedIndex existingIndex, String workspaceName, NodeTypes.Supplier nodeTypesSupplier, ChangeSetAdapter.NodeTypePredicate matcher, IndexFeedback feedback)`

    Methods in org.modeshape.jcr.index.local with parameters of type ManagedIndex
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | LocalIndexProvider.`planUseOfIndex(QueryContext context, IndexCostCalculator calculator, String workspaceName, ManagedIndex index, IndexDefinition defn)`
    `protected void` | LocalIndexProvider.`removeIndex(IndexDefinition oldDefn, ManagedIndex existingIndex, String workspaceName)`
    `protected ManagedIndex` | LocalIndexProvider.`updateIndex(IndexDefinition oldDefn, IndexDefinition updatedDefn, ManagedIndex existingIndex, String workspaceName, NodeTypes.Supplier nodeTypesSupplier, ChangeSetAdapter.NodeTypePredicate matcher, IndexFeedback feedback)`

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

    Methods in org.modeshape.jcr.spi.index.provider that return ManagedIndex
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract ManagedIndex` | IndexProvider.`createIndex(IndexDefinition defn, String workspaceName, NodeTypes.Supplier nodeTypesSupplier, ChangeSetAdapter.NodeTypePredicate matcher, IndexFeedback feedback)` Method called when this provider needs to create a new index given the unique pair of workspace name and index definition.
    `protected abstract ManagedIndex` | IndexProvider.`updateIndex(IndexDefinition oldDefn, IndexDefinition updatedDefn, ManagedIndex existingIndex, String workspaceName, NodeTypes.Supplier nodeTypesSupplier, ChangeSetAdapter.NodeTypePredicate matcher, IndexFeedback feedback)` Method called when this provider needs to update an existing index given the unique pair of workspace name and index definition.

    Methods in org.modeshape.jcr.spi.index.provider that return types with arguments of type ManagedIndex
    Modifier and Type | Method and Description
    --- | ---
    `protected Iterable<ManagedIndex>` | IndexProvider.`getIndexes(String workspaceName)` Get this provider's `ProvidedIndex` instances for the given workspace.

    Methods in org.modeshape.jcr.spi.index.provider with parameters of type ManagedIndex
    Modifier and Type | Method and Description
    --- | ---
    `void` | IndexProvider.ManagedIndexOperation.`apply(String workspaceName, ManagedIndex index, IndexDefinition defn)` Apply the operation to a managed index
    `protected abstract void` | IndexProvider.`planUseOfIndex(QueryContext context, IndexCostCalculator calculator, String workspaceName, ManagedIndex index, IndexDefinition defn)` The method that is called by the IndexProvider's `default IndexPlanner` for each managed index in the given workspace.
    `protected abstract void` | IndexProvider.`removeIndex(IndexDefinition oldDefn, ManagedIndex existingIndex, String workspaceName)` Method called when this provider needs to remove an existing index given the unique pair of workspace name and index definition.
    `protected abstract ManagedIndex` | IndexProvider.`updateIndex(IndexDefinition oldDefn, IndexDefinition updatedDefn, ManagedIndex existingIndex, String workspaceName, NodeTypes.Supplier nodeTypesSupplier, ChangeSetAdapter.NodeTypePredicate matcher, IndexFeedback feedback)` Method called when this provider needs to update an existing index given the unique pair of workspace name and index definition.

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