/*
Jazzy - a Java library for Spell Checking
Copyright (C) 2001 Mindaugas Idzelis
Full text of license can be found in LICENSE.txt
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package com.swabunga.spell.event;
import java.util.List;
/**
* This event is fired off by the SpellChecker and is passed to the registered SpellCheckListeners
*
* @author Jason Height (jheight@chariot.net.au)
*/
class BasicSpellCheckEvent implements SpellCheckEvent {
/** The list holding the suggested Word objects for the misspelt word */
private List suggestions;
/** The misspelt word */
private String invalidWord;
/** The action to be done when the event returns */
private short action = INITIAL;
/** Contains the word to be replaced if the action is REPLACE or REPLACEALL */
private String replaceWord = null;
private String context;
private int startPosition;
/**
* Consructs the SpellCheckEvent
*
* @param invalidWord
* The word that is misspelt
* @param suggestions
* A list of Word objects that are suggested to replace the currently mispelt word
* @param tokenizer
* The reference to the tokenizer that caused this event to fire.
*/
public BasicSpellCheckEvent(String invalidWord, List suggestions, WordTokenizer tokenizer) {
this.invalidWord = invalidWord;
this.suggestions = suggestions;
this.context = tokenizer.getContext();
this.startPosition = tokenizer.getCurrentWordPosition();
}
/** Returns the list of suggested Word objects */
@Override
public List getSuggestions() {
return suggestions;
}
/** Returns the currently misspelt word */
@Override
public String getInvalidWord() {
return invalidWord;
}
@Override
public String getWordContext() {
// JMH TBD
return null;
}
/** Returns the start position of the misspelt word in the context */
@Override
public int getWordContextPosition() {
return startPosition;
}
@Override
public short getAction() {
return action;
}
@Override
public String getReplaceWord() {
return replaceWord;
}
/**
* Set the action to replace the currently misspelt word with the new word
*
* @param String
* newWord The word to replace the currently misspelt word
* @param boolean replaceAll If set to true, the SpellChecker will replace all further occurances of the misspelt word without firing a
* SpellCheckEvent.
*/
@Override
public void replaceWord(String newWord, boolean replaceAll) {
if (action != INITIAL) {
throw new IllegalStateException("The action can can only be set once");
}
if (replaceAll) {
action = REPLACEALL;
} else {
action = REPLACE;
}
replaceWord = newWord;
}
/**
* Set the action it ignore the currently misspelt word.
*
* @param boolean ignoreAll If set to true, the SpellChecker will replace all further occurances of the misspelt word without firing a
* SpellCheckEvent.
*/
@Override
public void ignoreWord(boolean ignoreAll) {
if (action != INITIAL) {
throw new IllegalStateException("The action can can only be set once");
}
if (ignoreAll) {
action = IGNOREALL;
} else {
action = IGNORE;
}
}
/**
* Set the action to add a new word into the dictionary. This will also replace the currently misspelt word.
*/
@Override
public void addToDictionary(String newWord) {
if (action != INITIAL) {
throw new IllegalStateException("The action can can only be set once");
}
action = ADDTODICT;
replaceWord = newWord;
}
@Override
public void cancel() {
if (action != INITIAL) {
throw new IllegalStateException("The action can can only be set once");
}
action = CANCEL;
}
}