org.apache.uima.fit.factory

## Class FsIndexFactory

- java.lang.Object
- - org.apache.uima.fit.factory.FsIndexFactory

-     public final class FsIndexFactory
      extends Object

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `REVERSE_STANDARD_COMPARE` Comparator that orders FeatureStructures according to the reverse order of their key features (the opposite order as that defined by STANDARD_COMPARE).
    `static int` | `STANDARD_COMPARE` Comparator that orders FeatureStructures according to the standard order of their key features.

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static FsIndexCollection` | `createFsIndexCollection()` Creates a `FsIndexCollection` from all index descriptions that can be found via the pattern specified in the system property `org.apache.uima.fit.fsindex.import_pattern` or via the `META-INF/org.apache.uima.fit/fsindexes.txt` files in the classpath.
    `static FsIndexCollection` | `createFsIndexCollection(Class<?> componentClass)` Create index configuration data for a given class definition using reflection and the configuration parameter annotation.
    `static FsIndexCollection` | `createFsIndexCollection(FsIndexDescription... descriptions)` Create a index collection from a set of descriptions.
    `static FsIndexCollection` | `createFsIndexCollection(String... descriptorNames)` Creates a `FsIndexCollection` from descriptor names.
    `static FsIndexDescription` | `createFsIndexDescription(String label, String kind, String typeName, boolean useTypePriorities, FsIndexKeyDescription... keys)`
    `static FsIndexKeyDescription` | `createFsIndexKeyDescription(String featureName)`
    `static FsIndexKeyDescription` | `createFsIndexKeyDescription(String featureName, int comparator)`
    `static FsIndexCollection` | `createTypeSystemDescriptionFromPath(String... descriptorURIs)` Creates a `FsIndexCollection` from a descriptor file
    `static void` | `forceIndexDescriptorsScan()` Force rescan of index descriptors.
    `static String[]` | `scanIndexDescriptors()` Get all currently accessible index descriptor locations.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### STANDARD_COMPARE

          public static final int STANDARD_COMPARE

      Comparator that orders FeatureStructures according to the standard order of their key features. For integer and float values, this is the standard linear order, and for strings it is lexicographic order.
      See Also:
        Constant Field Values

    - #### REVERSE_STANDARD_COMPARE

          public static final int REVERSE_STANDARD_COMPARE

      Comparator that orders FeatureStructures according to the reverse order of their key features (the opposite order as that defined by STANDARD_COMPARE).
      See Also:
        Constant Field Values

  - ### Method Detail

    - #### createFsIndexCollection

          public static FsIndexCollection createFsIndexCollection(Class<?> componentClass)

      Create index configuration data for a given class definition using reflection and the configuration parameter annotation.
      Parameters:
        `componentClass` - the class to analyze
      Returns:
        the index collection

    - #### createFsIndexDescription

          public static FsIndexDescription createFsIndexDescription(String label,
                                                                    String kind,
                                                                    String typeName,
                                                                    boolean useTypePriorities,
                                                                    FsIndexKeyDescription... keys)

      Parameters:
        `label` - the index label
        `kind` - the type of index
        `typeName` - the indexed feature structure type
        `useTypePriorities` - whether to respect type priorities
        `keys` - the index keys
      Returns:
        the index description

    - #### createFsIndexCollection

          public static FsIndexCollection createFsIndexCollection(FsIndexDescription... descriptions)

      Create a index collection from a set of descriptions.
      Parameters:
        `descriptions` - the index descriptions
      Returns:
        the index collection

    - #### createFsIndexKeyDescription

          public static FsIndexKeyDescription createFsIndexKeyDescription(String featureName)

      Parameters:
        `featureName` - the feature to index
      Returns:
        the index key description

    - #### createFsIndexKeyDescription

          public static FsIndexKeyDescription createFsIndexKeyDescription(String featureName,
                                                                          int comparator)

      Parameters:
        `featureName` - the feature to index
        `comparator` - the index comparator
      Returns:
        the index key description

    - #### createFsIndexCollection

          public static FsIndexCollection createFsIndexCollection(String... descriptorNames)

      Creates a `FsIndexCollection` from descriptor names.
      Parameters:
        `descriptorNames` - The fully qualified, Java-style, dotted descriptor names.
      Returns:
        a `FsIndexCollection` that includes the indexes from all of the specified files.

    - #### createTypeSystemDescriptionFromPath

          public static FsIndexCollection createTypeSystemDescriptionFromPath(String... descriptorURIs)

      Creates a `FsIndexCollection` from a descriptor file
      Parameters:
        `descriptorURIs` - The descriptor file paths.
      Returns:
        A `FsIndexCollection` that includes the indexes from all of the specified files.

    - #### createFsIndexCollection

          public static FsIndexCollection createFsIndexCollection()
                                                           throws ResourceInitializationException

      Creates a `FsIndexCollection` from all index descriptions that can be found via the pattern specified in the system property `org.apache.uima.fit.fsindex.import_pattern` or via the `META-INF/org.apache.uima.fit/fsindexes.txt` files in the classpath.
      Returns:
        the auto-scanned indexes.
      Throws:
        `ResourceInitializationException` - if the index collection could not be assembled

    - #### scanIndexDescriptors

          public static String[] scanIndexDescriptors()
                                               throws ResourceInitializationException

      Get all currently accessible index descriptor locations. A scan is actually only performed on the first call and the locations are cached. To force a re-scan use `forceIndexDescriptorsScan()`.
      Returns:
        an array of locations.
      Throws:
        `ResourceInitializationException` - if the locations could not be resolved.

    - #### forceIndexDescriptorsScan

          public static void forceIndexDescriptorsScan()

      Force rescan of index descriptors. The next call to `scanIndexDescriptors()` will rescan all auto-import locations.

Copyright © 2012–2021 The Apache Software Foundation. All rights reserved.