com.xmlmind.xmleditapp.spellchecker

Class NoSpellChecker

java.lang.Object

com.xmlmind.xmleditapp.spellchecker.NoSpellChecker

All Implemented Interfaces:

SpellChecker

public final class NoSpellChecker
extends Object
implements SpellChecker

No-op implementation of a SpellChecker. Use it when no real implementation is available.

Field Summary

Fields

Modifier and Type	Field and Description
static NoSpellChecker	INSTANCE

Fields inherited from interface com.xmlmind.xmleditapp.spellchecker.SpellChecker

ERR_DUPLICATE, ERR_NONE, ERR_PUNCTUATION, ERR_REPLACE, ERR_UNKNOWN_WORD, ERR_WRONG_CAP

Constructor Summary

Constructors

Constructor and Description
NoSpellChecker()

Method Summary

Modifier and Type	Method and Description
int	checkNext() Detects the next error in the input text specified using SpellChecker.setInput(java.lang.CharSequence).
CharSequence	getInput() Returns the input text last specified using SpellChecker.setInput(java.lang.CharSequence).
int	getPosition() Gets the current position relatively to the current text sequence.
String	getReplacement(String word) Returns a replacement value learned using SpellChecker.learnAutoReplacement(java.lang.String, java.lang.String).
String	getSelectedLanguage() Returns the name of the currently selected language.
String[]	getSuggestions() Returns suggestions for the erroneous word detected by SpellChecker.checkNext().
String	getWord() Returns the erroneous word detected by SpellChecker.checkNext().
boolean	learnAutoReplacement(String word, String replacement) Record an ``automatic replacement'' for an erroneous word.
boolean	learnSuggestion(String word, String suggestion) Record the best suggestion for an erroneous word.
boolean	learnWord(String word, boolean persist) Stores a word into the personal dictionary or into the temporary (session wise) dictionary.
void	setInput(CharSequence input) Sets the input text before calling SpellChecker.checkNext().
boolean	setSelectedLanguage(String lang) Selects a language.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NoSpellChecker INSTANCE

Constructor Detail

NoSpellChecker

public NoSpellChecker()

Method Detail

setSelectedLanguage

public boolean setSelectedLanguage(String lang)

Description copied from interface: SpellChecker

Selects a language.

Specified by:

setSelectedLanguage in interface SpellChecker

Parameters:

lang - ISO-639-1 code of the language

Returns:

true if the language has been selected; false otherwise (unknown language, corrupted dictionary, etc)

getSelectedLanguage

public String getSelectedLanguage()

Description copied from interface: SpellChecker

Returns the name of the currently selected language. May return null.

Specified by:

getSelectedLanguage in interface SpellChecker

setInput

public void setInput(CharSequence input)

Description copied from interface: SpellChecker

Sets the input text before calling SpellChecker.checkNext().

Specified by:

setInput in interface SpellChecker

Parameters:

input - a fragment of text to check. This fragment must not begin or end in the middle of a word.

getInput

public CharSequence getInput()

Description copied from interface: SpellChecker

Returns the input text last specified using SpellChecker.setInput(java.lang.CharSequence).

Specified by:

getInput in interface SpellChecker

checkNext

public int checkNext()

Description copied from interface: SpellChecker

Detects the next error in the input text specified using SpellChecker.setInput(java.lang.CharSequence).

Specified by:

checkNext in interface SpellChecker

Returns:

ERR_NONE or the check status code (ERR_REPLACE, ERR_UNKNOWN_WORD, ERR_WRONG_CAP, ERR_PUNCTUATION, ERR_DUPLICATE).

getPosition

public int getPosition()

Description copied from interface: SpellChecker

Gets the current position relatively to the current text sequence.

Specified by:

getPosition in interface SpellChecker

Returns:

the current position counted from 0 in characters

getWord

public String getWord()

Description copied from interface: SpellChecker

Returns the erroneous word detected by SpellChecker.checkNext().

Specified by:

getWord in interface SpellChecker

getSuggestions

public String[] getSuggestions()

Description copied from interface: SpellChecker

Returns suggestions for the erroneous word detected by SpellChecker.checkNext().

Applicable to ERR_UNKNOWN_WORD, ERR_PUNCTUATION, ERR_WRONG_CAP.

Specified by:

getSuggestions in interface SpellChecker

Returns:

a (possibly empty, never null) list of suggestions

learnWord

public boolean learnWord(String word,
                         boolean persist)

Description copied from interface: SpellChecker

Stores a word into the personal dictionary or into the temporary (session wise) dictionary.

Notice that there is no savePersonalDictionary method. Learned words are automatically saved to disk.

Specified by:

learnWord in interface SpellChecker

Parameters:

word - word to learn

persist - if true, store word into personal dictionary; otherwise store it in a temporary (session wise) dictionary

Returns:

true if the word has been learned; false otherwise (no language is selected, the word contains an illegal character, etc)

learnSuggestion

public boolean learnSuggestion(String word,
                               String suggestion)

Description copied from interface: SpellChecker

Record the best suggestion for an erroneous word.

The next time the word will be passed to SpellChecker.getSuggestions(), the replacement value will be put atop the suggestion list.

This method should be used only when the correction entered by a user is not among the (first) suggestions proposed by getSuggestions.

Specified by:

learnSuggestion in interface SpellChecker

Parameters:

word - word to learn

suggestion - best suggestion for word

Returns:

true if the word has been learned; false otherwise (no language is selected, the word contains an illegal character, etc)

learnAutoReplacement

public boolean learnAutoReplacement(String word,
                                    String replacement)

Description copied from interface: SpellChecker

Record an ``automatic replacement'' for an erroneous word.

Specified by:

learnAutoReplacement in interface SpellChecker

Parameters:

word - word to learn

replacement - automatic replacement for word

Returns:

true if the word has been learned; false otherwise (no language is selected, the word contains an illegal character, etc)

getReplacement

public String getReplacement(String word)

Description copied from interface: SpellChecker

Returns a replacement value learned using SpellChecker.learnAutoReplacement(java.lang.String, java.lang.String).

Specified by:

getReplacement in interface SpellChecker

Returns:

the replacement word or null if a replacement word has not been learned