de.tudarmstadt.ukp.dkpro.core.decompounding.dictionary

Class SimpleDictionary

java.lang.Object

de.tudarmstadt.ukp.dkpro.core.decompounding.dictionary.SimpleDictionary

All Implemented Interfaces:

Dictionary

Direct Known Subclasses:

German98Dictionary

public class SimpleDictionary
extends Object
implements Dictionary

The simple dictionary reads a file in which each line is a new word. This can be used to create your own dictionary from a corpus

Constructor Summary

Constructors

Constructor and Description
SimpleDictionary(File aDict, String aEncoding) Constructor for a simple dictionary
SimpleDictionary(InputStream aDictStream, String aEncoding)
SimpleDictionary(String... aWords) Create a simple dictionary from a list of string.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String aWord) Checks if a word is in the dictionary.
List<String>	getAll() Returns all words in the dictionary.
protected Set<String>	readFileToSet(BufferedReader aReader) Reads the dictionary to set
void	setWords(Set<String> aWords)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDictionary

public SimpleDictionary(File aDict,
                        String aEncoding)
                 throws IOException

Constructor for a simple dictionary

Parameters:

aDict - The file with all words

Throws:

IOException

SimpleDictionary

public SimpleDictionary(String... aWords)

Create a simple dictionary from a list of string. This can be used for testing

Parameters:

aWords - A list of words

SimpleDictionary

public SimpleDictionary(InputStream aDictStream,
                        String aEncoding)
                 throws IOException

Throws:

IOException

Method Detail

contains

public boolean contains(String aWord)

Description copied from interface: Dictionary

Checks if a word is in the dictionary.

Specified by:

contains in interface Dictionary

Parameters:

aWord - a word.

Returns:

if a word is in the dictionary.

readFileToSet

protected Set<String> readFileToSet(BufferedReader aReader)
                             throws IOException

Reads the dictionary to set

Parameters:

aReader - a reader,

Returns:

A set of words

Throws:

IOException - if an I/O error occurs.

getAll

public List<String> getAll()

Description copied from interface: Dictionary

Returns all words in the dictionary.

Specified by:

getAll in interface Dictionary

Returns:

all words in the dictionary.

setWords

public void setWords(Set<String> aWords)