de.tudarmstadt.ukp.dkpro.core.api.featurepath

Class FeaturePathUtils

java.lang.Object

de.tudarmstadt.ukp.dkpro.core.api.featurepath.FeaturePathUtils

public class FeaturePathUtils
extends Object

Utility methods for using feature paths.

Constructor Summary

Constructors

Constructor and Description
FeaturePathUtils()

Method Summary

Modifier and Type	Method and Description
static FeaturePathFactory.FeaturePathIterator<org.apache.uima.cas.text.AnnotationFS>	featurePathIterator(org.apache.uima.jcas.JCas aJCas, String featurePath, Optional<org.apache.uima.cas.text.AnnotationFS> coveringAnnotation) Returns a FeaturePathFactory.FeaturePathIterator over all annotations of the given feature path.
static org.apache.uima.cas.Type	getType(org.apache.uima.cas.TypeSystem typeSystem, String typeName) Get the Type for a given name from a TypeSystem.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeaturePathUtils

public FeaturePathUtils()

Method Detail

featurePathIterator

public static FeaturePathFactory.FeaturePathIterator<org.apache.uima.cas.text.AnnotationFS> featurePathIterator(org.apache.uima.jcas.JCas aJCas,
                                                                                                                String featurePath,
                                                                                                                Optional<org.apache.uima.cas.text.AnnotationFS> coveringAnnotation)
                                                                                                         throws FeaturePathException

Returns a FeaturePathFactory.FeaturePathIterator over all annotations of the given feature path.

If the optional coveringAnnotation is set, the iterator contains only annotations of the feature path that are covered by the covering annotation (e.g. a sentence instance).

Parameters:

aJCas - a JCas

featurePath - a string representation of a feature path, for instance de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.Token

coveringAnnotation - an Optional containing an AnnotationFS or nothing.

Returns:

a FeaturePathFactory.FeaturePathIterator of type AnnotationFS

Throws:

FeaturePathException - if an error occurs during initialization of the feature path

getType

public static org.apache.uima.cas.Type getType(org.apache.uima.cas.TypeSystem typeSystem,
                                               String typeName)

Get the Type for a given name from a TypeSystem. Throws a IllegalStateException if the type name cannot be resolved.

Parameters:

typeSystem - the TypeSystem

typeName - the type name

Returns:

a Type

Throws:

IllegalStateException - if the type name cannot be resolved