uk.ac.open.crc.mdsc.wordlists

Class Wordlist

java.lang.Object

uk.ac.open.crc.mdsc.wordlists.Wordlist

public class Wordlist
extends java.lang.Object

Provides a list of 'words' from one of the mdsc files. See Wordlists for details of available files. The constructors allow the specification of lower case and that words contain a minimum number of characters. The latter is supports some applications where short tokens can lead to noisy results.

Constructor Summary

Constructors

Constructor and Description
Wordlist(Wordlists wordListName) Creates a list of 'words' from the specified source file.
Wordlist(Wordlists wordListName, boolean normalised) Creates a list of 'words' from the specified source file and allows the words to be normalised to lower case.
Wordlist(Wordlists wordListName, boolean normalised, int minimumLength) Creates a list of 'words' from the specified source file, that can be normalised to lower case, and consists of at least a minimum number of characters.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	list() Returns the list of words.

Methods inherited from class java.lang.Object

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

Constructor Detail

Wordlist

public Wordlist(Wordlists wordListName)

Creates a list of 'words' from the specified source file.

Parameters:

wordListName - a constant from the Wordlists enumeration

Wordlist

public Wordlist(Wordlists wordListName,
                boolean normalised)

Creates a list of 'words' from the specified source file and allows the words to be normalised to lower case.

Parameters:

wordListName - a constant from the Wordlists enumeration

normalised - a boolean that indicates whether words in the recovered list should be normalised to lower case.

Wordlist

public Wordlist(Wordlists wordListName,
                boolean normalised,
                int minimumLength)

Creates a list of 'words' from the specified source file, that can be normalised to lower case, and consists of at least a minimum number of characters.

Parameters:

wordListName - a constant from the Wordlists enumeration

normalised - a boolean that indicates whether words in the recovered list should be normalised to lower case.

minimumLength - the length of the shortest token to include in the wordlist. 1 loads every token, and is the default for the other constructors.

Method Detail

list

public java.util.List<java.lang.String> list()

Returns the list of words.

Returns:

a List of 'words'