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

Class FeaturePathFactory

java.lang.Object

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

public class FeaturePathFactory
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FeaturePathFactory.FeaturePathIterator<T extends org.apache.uima.cas.text.AnnotationFS>

Constructor Summary

Constructors

Constructor and Description
FeaturePathFactory()

Method Summary

Modifier and Type	Method and Description
static Iterable<Map.Entry<org.apache.uima.cas.text.AnnotationFS,String>>	select(org.apache.uima.cas.CAS aCas, String aPath) Select annotation/value pairs matching the given feature path.
static <T extends org.apache.uima.jcas.tcas.Annotation> Iterable<Map.Entry<T,String>>	select(org.apache.uima.jcas.JCas aJCas, Class<T> aAnchor, String aPath) Select annotation/value pairs matching the given feature path.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeaturePathFactory

public FeaturePathFactory()

Method Detail

select

public static Iterable<Map.Entry<org.apache.uima.cas.text.AnnotationFS,String>> select(org.apache.uima.cas.CAS aCas,
                                                                                       String aPath)
                                                                                throws FeaturePathException

Select annotation/value pairs matching the given feature path. The path has to start with a fully qualified type name - the anchor type - followed by a feature path. This function can be used in extended for-loops.

Parameters:

aCas - the CAS to search in.

aPath - the full feature path.

Returns:

annotation/value pairs.

Throws:

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

select

public static <T extends org.apache.uima.jcas.tcas.Annotation> Iterable<Map.Entry<T,String>> select(org.apache.uima.jcas.JCas aJCas,
                                                                                                    Class<T> aAnchor,
                                                                                                    String aPath)
                                                                                             throws FeaturePathException

Select annotation/value pairs matching the given feature path. The path has to start with a fully qualified type name followed by a feature path. This function can be used in extended for-loops.

Type Parameters:

T - the anchor type.

Parameters:

aJCas - the JCas to search in.

aAnchor - the anchor type.

aPath - a feature path relative to the anchor type.

Returns:

annotation/value pairs.

Throws:

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