## Uses of Interface
org.apache.uima.resource.metadata.FsIndexDescription

- Packages that use FsIndexDescription
  Package | Description
  --- | ---
  org.apache.uima | The main package for the Unstructured Information Management Middleware Architecture.
  org.apache.uima.resource | Interfaces for `Resources` and `ResourceSpecifiers`.
  org.apache.uima.resource.metadata | Interfaces for objects that represent metadata for a Resource.
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.

- - ### Uses of FsIndexDescription in org.apache.uima

    Methods in org.apache.uima that return FsIndexDescription
    Modifier and Type | Method and Description
    --- | ---
    `FsIndexDescription` | ResourceSpecifierFactory.`createFsIndexDescription()` Creates an `FsIndexDescription`.

  - ### Uses of FsIndexDescription in org.apache.uima.resource

    Methods in org.apache.uima.resource that return FsIndexDescription
    Modifier and Type | Method and Description
    --- | ---
    `FsIndexDescription[]` | CasDefinition.`getFsIndexDescriptions()`

    Methods in org.apache.uima.resource with parameters of type FsIndexDescription
    Modifier and Type | Method and Description
    --- | ---
    `void` | CasDefinition.`setFsIndexDescriptions(FsIndexDescription[] fsIndexDescriptions)`

    Constructors in org.apache.uima.resource with parameters of type FsIndexDescription
    Constructor and Description
    `CasDefinition(TypeSystemDescription aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, ResourceManager aResourceManager, Properties aPerformanceTuningSettings)`

  - ### Uses of FsIndexDescription in org.apache.uima.resource.metadata

    Fields in org.apache.uima.resource.metadata declared as FsIndexDescription
    Modifier and Type | Field and Description
    --- | ---
    `static FsIndexDescription[]` | FsIndexDescription.`EMPTY_FS_INDEX_DESCRIPTIONS`

    Methods in org.apache.uima.resource.metadata that return FsIndexDescription
    Modifier and Type | Method and Description
    --- | ---
    `FsIndexDescription[]` | FsIndexCollection.`getFsIndexes()` Retrieves the FS Index descriptions that are part of this collection.
    `FsIndexDescription[]` | ProcessingResourceMetaData.`getFsIndexes()` Retrieves the Feature Structure indexes by this Processing Resource.

    Methods in org.apache.uima.resource.metadata with parameters of type FsIndexDescription
    Modifier and Type | Method and Description
    --- | ---
    `void` | FsIndexCollection.`addFsIndex(FsIndexDescription aFsIndexDescription)` Adds an FS Index description to this collection.
    `void` | FsIndexCollection.`removeFsIndex(FsIndexDescription aFsIndexDescription)` Removes an FS Index description from this collection.
    `void` | FsIndexCollection.`setFsIndexes(FsIndexDescription[] aFSIndexes)` Retrieves the FS Index descriptions that are part of this collection.
    `void` | ProcessingResourceMetaData.`setFsIndexes(FsIndexDescription[] aFSIndexes)` Sets the Feature Structure indexes by this Processing Resource.

  - ### Uses of FsIndexDescription in org.apache.uima.util

    Methods in org.apache.uima.util with parameters of type FsIndexDescription
    Modifier and Type | Method and Description
    --- | ---
    `static CAS` | CasCreationUtils.`createCas(TypeSystemDescription aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes)` Creates a new CAS instance.
    `static CAS` | CasCreationUtils.`createCas(TypeSystemDescription aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings)` Creates a new CAS instance.
    `static CAS` | CasCreationUtils.`createCas(TypeSystemDescription aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings, ResourceManager aResourceManager)` Creates a new CAS instance.
    `static CAS` | CasCreationUtils.`createCas(TypeSystem aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings)` Creates a new CAS instance that reuses an existing type system.
    `static CAS` | CasCreationUtils.`createCas(TypeSystem aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings, ResourceManager aResourceManager)` Creates a new CAS instance that reuses an existing type system.
    `static void` | CasCreationUtils.`setupIndexes(CASMgr aCASMgr, FsIndexDescription[] aIndexes)` Adds FeatureStructure indexes to a CAS.

Copyright © 2006–2019 The Apache Software Foundation. All rights reserved.