public final class FsIndexFactory extends Object
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.
|
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.
|
public static final int STANDARD_COMPARE
public static final int REVERSE_STANDARD_COMPARE
public static FsIndexCollection createFsIndexCollection(Class<?> componentClass)
componentClass
- the class to analyzepublic static FsIndexDescription createFsIndexDescription(String label, String kind, String typeName, boolean useTypePriorities, FsIndexKeyDescription... keys)
label
- the index labelkind
- the type of indextypeName
- the indexed feature structure typeuseTypePriorities
- whether to respect type prioritieskeys
- the index keyspublic static FsIndexCollection createFsIndexCollection(FsIndexDescription... descriptions)
descriptions
- the index descriptionspublic static FsIndexKeyDescription createFsIndexKeyDescription(String featureName)
featureName
- the feature to indexpublic static FsIndexKeyDescription createFsIndexKeyDescription(String featureName, int comparator)
featureName
- the feature to indexcomparator
- the index comparatorpublic static FsIndexCollection createFsIndexCollection(String... descriptorNames)
FsIndexCollection
from descriptor names.descriptorNames
- The fully qualified, Java-style, dotted descriptor names.FsIndexCollection
that includes the indexes from all of the specified files.public static FsIndexCollection createTypeSystemDescriptionFromPath(String... descriptorURIs)
FsIndexCollection
from a descriptor filedescriptorURIs
- The descriptor file paths.FsIndexCollection
that includes the indexes from all of the specified files.public static FsIndexCollection createFsIndexCollection() throws ResourceInitializationException
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.ResourceInitializationException
- if the index collection could not be assembledpublic static String[] scanIndexDescriptors() throws ResourceInitializationException
forceIndexDescriptorsScan()
.ResourceInitializationException
- if the locations could not be resolved.public static void forceIndexDescriptorsScan()
scanIndexDescriptors()
will rescan
all auto-import locations.Copyright © 2012–2020 The Apache Software Foundation. All rights reserved.