uk.ac.open.crc.mdsc

Class Result

java.lang.Object

uk.ac.open.crc.mdsc.Result

public class Result
extends java.lang.Object

The result of a spell check using a single dictionary.

Method Summary

Modifier and Type	Method and Description
java.lang.String	dictionaryName() The name of the dictionary used.
boolean	isCorrect() Indicates whether the 'word' is correctly spelt in the queried dictionaries.
java.util.ArrayList<SuggestedSpelling>	suggestions() Retrieves a list of suggested alternative spellings.
java.lang.String	word() The word that was spell-checked.

Methods inherited from class java.lang.Object

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

Method Detail

isCorrect

public boolean isCorrect()

Indicates whether the 'word' is correctly spelt in the queried dictionaries.

Returns:

true if the word was found in the dictionary.

dictionaryName

public java.lang.String dictionaryName()

The name of the dictionary used.

Returns:

a String identifying the dictionary.

word

public java.lang.String word()

The word that was spell-checked.

Returns:

the string tested

suggestions

public java.util.ArrayList<SuggestedSpelling> suggestions()

Retrieves a list of suggested alternative spellings.

Returns:

a list of suggested spellings