de.tudarmstadt.ukp.dkpro.core.api.io.sequencegenerator

Class PhraseSequenceGenerator

java.lang.Object

de.tudarmstadt.ukp.dkpro.core.api.io.sequencegenerator.PhraseSequenceGenerator

public class PhraseSequenceGenerator
extends Object

Generate sequences of phrases with optional stopword/regex-based filtering, and lowercasing. Filtered tokens are added as LexicalPhrases with empty text or a replacement of the text, if stopwordReplacement and/or PhraseSequenceGenerator.Builder.filterRegexReplacement were set.

Initialize with PhraseSequenceGenerator.Builder.build().

When strings instead of LexicalPhrases should be output, use PhraseSequenceGenerator.Builder.buildStringSequenceGenerator().

Since:

1.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhraseSequenceGenerator.Builder Builder for PhraseSequenceGenerators.

Field Summary

Fields

Modifier and Type	Field and Description
static String	WHITESPACE_CHAR_REPLACEMENT

Method Summary

Modifier and Type	Method and Description
List<LexicalPhrase[]>	tokenSequences(org.apache.uima.jcas.JCas aJCas) Generate a list of LexicalPhrase sequences where each list element represents phrases extracted from the covering types, e.g.

Methods inherited from class java.lang.Object

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

Field Detail

WHITESPACE_CHAR_REPLACEMENT

public static final String WHITESPACE_CHAR_REPLACEMENT

See Also:

Constant Field Values

Method Detail

tokenSequences

public List<LexicalPhrase[]> tokenSequences(org.apache.uima.jcas.JCas aJCas)
                                     throws FeaturePathException

Generate a list of LexicalPhrase sequences where each list element represents phrases extracted from the covering types, e.g. a sentence. If no covering type was defined, the list contains one element representing the whole document.

Parameters:

aJCas - a JCas

Returns:

a list of LexicalPhrase arrays

Throws:

FeaturePathException - if there was a problem creating the feature path.