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 org.apache.uima.resource.metadata.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 org.apache.uima.resource.metadata.FsIndexCollection |
createFsIndexCollection(Class<?> componentClass)
Create index configuration data for a given class definition using reflection and the
configuration parameter annotation.
|
static org.apache.uima.resource.metadata.FsIndexCollection |
createFsIndexCollection(org.apache.uima.resource.metadata.FsIndexDescription... descriptions)
Create a index collection from a set of descriptions.
|
static org.apache.uima.resource.metadata.FsIndexCollection |
createFsIndexCollection(String... descriptorNames)
Creates a
FsIndexCollection from descriptor names. |
static org.apache.uima.resource.metadata.FsIndexDescription |
createFsIndexDescription(String label,
String kind,
String typeName,
boolean useTypePriorities,
org.apache.uima.resource.metadata.FsIndexKeyDescription... keys) |
static org.apache.uima.resource.metadata.FsIndexKeyDescription |
createFsIndexKeyDescription(String featureName) |
static org.apache.uima.resource.metadata.FsIndexKeyDescription |
createFsIndexKeyDescription(String featureName,
int comparator) |
static org.apache.uima.resource.metadata.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 org.apache.uima.resource.metadata.FsIndexCollection createFsIndexCollection(Class<?> componentClass)
componentClass
- the class to analyzepublic static org.apache.uima.resource.metadata.FsIndexDescription createFsIndexDescription(String label, String kind, String typeName, boolean useTypePriorities, org.apache.uima.resource.metadata.FsIndexKeyDescription... keys)
label
- the index labelkind
- the type of indextypeName
- the indexed feature structure typeuseTypePriorities
- whether to respect type prioritieskeys
- the index keyspublic static org.apache.uima.resource.metadata.FsIndexCollection createFsIndexCollection(org.apache.uima.resource.metadata.FsIndexDescription... descriptions)
descriptions
- the index descriptionspublic static org.apache.uima.resource.metadata.FsIndexKeyDescription createFsIndexKeyDescription(String featureName)
featureName
- the feature to indexpublic static org.apache.uima.resource.metadata.FsIndexKeyDescription createFsIndexKeyDescription(String featureName, int comparator)
featureName
- the feature to indexcomparator
- the index comparatorpublic static org.apache.uima.resource.metadata.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 org.apache.uima.resource.metadata.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 org.apache.uima.resource.metadata.FsIndexCollection createFsIndexCollection() throws org.apache.uima.resource.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.org.apache.uima.resource.ResourceInitializationException
- if the index collection could not be assembledpublic static String[] scanIndexDescriptors() throws org.apache.uima.resource.ResourceInitializationException
forceIndexDescriptorsScan()
.org.apache.uima.resource.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.