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

Class PhraseSequenceGenerator.Builder

java.lang.Object

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

Enclosing class:

PhraseSequenceGenerator

public static class PhraseSequenceGenerator.Builder
extends Object

Builder for PhraseSequenceGenerators.

Alternative constructs a StringSequenceGenerator with buildStringSequenceGenerator()

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PhraseSequenceGenerator	build() Generate a PhraseSequenceGenerator
StringSequenceGenerator	buildStringSequenceGenerator() Generate a StringSequenceGenerator that directly returns Strings instead of LexicalPhrases.
PhraseSequenceGenerator.Builder	characters(boolean characters) If set to true, the generated phrases contain characters instead of tokens or other annotations.
PhraseSequenceGenerator.Builder	coveringType(String coveringType)
PhraseSequenceGenerator.Builder	featurePath(String featurePath)
PhraseSequenceGenerator.Builder	filterRegex(String filterRegex) This method can be called multiple times in order to add multiple regular expressions for filtering.
PhraseSequenceGenerator.Builder	filterRegexReplacement(String filterRegexReplacement)
PhraseSequenceGenerator.Builder	lowercase(boolean lowercase)
PhraseSequenceGenerator.Builder	minTokenLength(int minTokenLength)
PhraseSequenceGenerator.Builder	stopwordsFile(File stopwordsFile)
PhraseSequenceGenerator.Builder	stopwordsFile(String stopwordsFile)
PhraseSequenceGenerator.Builder	stopwordsReplacement(String stopwordsReplacement)
PhraseSequenceGenerator.Builder	stopwordsURL(URL stopwordsURL)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

featurePath

public PhraseSequenceGenerator.Builder featurePath(String featurePath)

Parameters:

featurePath - set the feature path to use for creating token sequences.

Returns:

a PhraseSequenceGenerator.Builder

stopwordsFile

public PhraseSequenceGenerator.Builder stopwordsFile(String stopwordsFile)
                                              throws MalformedURLException

Throws:

MalformedURLException

stopwordsFile

public PhraseSequenceGenerator.Builder stopwordsFile(File stopwordsFile)
                                              throws MalformedURLException

Throws:

MalformedURLException

stopwordsURL

public PhraseSequenceGenerator.Builder stopwordsURL(URL stopwordsURL)

Parameters:

stopwordsURL - set the location of the stopwords file

Returns:

a PhraseSequenceGenerator.Builder

stopwordsReplacement

public PhraseSequenceGenerator.Builder stopwordsReplacement(String stopwordsReplacement)

Parameters:

stopwordsReplacement - stopwords are replaced by this string or removed if replacement string is empty

Returns:

a PhraseSequenceGenerator.Builder

minTokenLength

public PhraseSequenceGenerator.Builder minTokenLength(int minTokenLength)

Parameters:

minTokenLength - tokens shorter than the given length are filtered out

Returns:

a PhraseSequenceGenerator.Builder

filterRegex

public PhraseSequenceGenerator.Builder filterRegex(String filterRegex)

This method can be called multiple times in order to add multiple regular expressions for filtering. If a token matches any of the regular expression, it is omitted.

Parameters:

filterRegex - Tokens matching this regular expression are filtered out.

Returns:

a PhraseSequenceGenerator.Builder

filterRegexReplacement

public PhraseSequenceGenerator.Builder filterRegexReplacement(String filterRegexReplacement)

Parameters:

filterRegexReplacement - tokens matching the filterRegexes are replaced by this string. If this is empty, these tokens are removed.

Returns:

a PhraseSequenceGenerator.Builder

lowercase

public PhraseSequenceGenerator.Builder lowercase(boolean lowercase)

Parameters:

lowercase - If true, all tokens are lowercased

Returns:

a PhraseSequenceGenerator.Builder

coveringType

public PhraseSequenceGenerator.Builder coveringType(String coveringType)

Parameters:

coveringType - if set, a separate string sequence is generated for each sequence covered by the covering type, e.g. one sequence for each sentence.

Returns:

a PhraseSequenceGenerator.Builder

characters

public PhraseSequenceGenerator.Builder characters(boolean characters)

If set to true, the generated phrases contain characters instead of tokens or other annotations.

Parameters:

characters - a boolean

Returns:

a PhraseSequenceGenerator.Builder

build

public PhraseSequenceGenerator build()
                              throws IOException

Generate a PhraseSequenceGenerator

Returns:

a PhraseSequenceGenerator instance

Throws:

IOException - if a stopwords file is specified but cannot be read

buildStringSequenceGenerator

public StringSequenceGenerator buildStringSequenceGenerator()
                                                     throws IOException

Generate a StringSequenceGenerator that directly returns Strings instead of LexicalPhrases.

Returns:

a StringSequenceGenerator instance

Throws:

IOException - if a stopwords file is specified but cannot be read