/*
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.io.IOException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Vector;
import com.swabunga.spell.engine.Configuration;
import com.swabunga.spell.engine.SpellDictionary;
import com.swabunga.spell.engine.SpellDictionaryHashMap;
import com.swabunga.spell.engine.Word;
import com.swabunga.util.VectorUtility;
/**
* This is the main class for spell checking (using the new event based spell checking).
*
* @author Jason Height (jheight@chariot.net.au) 19 June 2002
*/
public class SpellChecker {
/** Flag indicating that the Spell Check completed without any errors present */
public static final int SPELLCHECK_OK = -1;
/** Flag indicating that the Spell Check completed due to user cancellation */
public static final int SPELLCHECK_CANCEL = -2;
private Vector<SpellCheckListener> eventListeners = new Vector<SpellCheckListener>();
private Vector<SpellDictionary> dictionaries = new Vector<SpellDictionary>();
private SpellDictionary userdictionary;
private Configuration config = Configuration.getConfiguration();
/** This variable holds all of the words that are to be always ignored */
private Vector<String> ignoredWords = new Vector<String>();
private Hashtable<String, String> autoReplaceWords = new Hashtable<String, String>();
// added caching - bd
// For cached operation a separate user dictionary is required
private Map<String, ArrayList<Word>> cache;
private int threshold = 0;
private int cacheSize = 0;
/**
* Constructs the SpellChecker.
*/
public SpellChecker() {
try {
userdictionary = new SpellDictionaryHashMap();
} catch (IOException e) {
throw new RuntimeException("this exception should never happen because we are using null phonetic file");
}
}
/**
* Constructs the SpellChecker. The default threshold is used
*
* @param dictionary
* Description of the Parameter
*/
public SpellChecker(SpellDictionary dictionary) {
this();
addDictionary(dictionary);
}
/**
* Constructs the SpellChecker with a threshold
*
* @param dictionary
* Description of the Parameter
* @param threshold
* Description of the Parameter
*/
public SpellChecker(SpellDictionary dictionary, int threshold) {
this(dictionary);
config.setInteger(Configuration.SPELL_THRESHOLD, threshold);
}
public void addDictionary(SpellDictionary dictionary) {
if (dictionary == null) {
throw new IllegalArgumentException("dictionary must be non-null");
}
this.dictionaries.addElement(dictionary);
}
/**
* Set user dictionary (used when a word is added)
*/
public void setUserDictionary(SpellDictionary dictionary) {
userdictionary = dictionary;
}
/**
*
* @return Current Configuration
*/
public Configuration getConfiguration() {
return config;
}
/**
* Adds a SpellCheckListener
*
* @param listener
* The feature to be added to the SpellCheckListener attribute
*/
public void addSpellCheckListener(SpellCheckListener listener) {
eventListeners.addElement(listener);
}
/**
* Removes a SpellCheckListener
*
* @param listener
* Description of the Parameter
*/
public void removeSpellCheckListener(SpellCheckListener listener) {
eventListeners.removeElement(listener);
}
/**
* Fires off a spell check event to the listeners.
*
* @param event
* Description of the Parameter
*/
protected void fireSpellCheckEvent(SpellCheckEvent event) {
for (int i = eventListeners.size() - 1; i >= 0; i--) {
eventListeners.elementAt(i).spellingError(event);
}
}
/**
* This method clears the words that are currently being remembered as Ignore All words and Replace All words.
*/
public void reset() {
ignoredWords = new Vector<String>();
autoReplaceWords = new Hashtable<String, String>();
}
/**
* Checks the text string.
* <p>
* Returns the corrected string.
*
* @param text
* Description of the Parameter
* @return Description of the Return Value
* @deprecated use checkSpelling(WordTokenizer)
*/
@Deprecated
public String checkString(String text) {
StringWordTokenizer tokens = new StringWordTokenizer(text);
checkSpelling(tokens);
return tokens.getContext();
}
/**
* Returns true iff this word contains a digit.
*
* @param word
* Description of the Parameter
* @return The digitWord value
*/
private final static boolean isDigitWord(String word) {
for (int i = word.length() - 1; i >= 0; i--) {
if (Character.isDigit(word.charAt(i))) {
return true;
}
}
return false;
}
/**
* Returns true iff this word looks like an internet address.
*
* One limitation is that this method cannot currently recognise email addresses. Since the 'word' that is passed in may in fact contain
* the rest of the document to be checked, it is not (yet!) a good idea to scan for the @ character.
*
* @param word
* Description of the Parameter
* @return The iNETWord value
*/
public final static boolean isINETWord(String word) {
String lowerCaseWord = word.toLowerCase();
return lowerCaseWord.startsWith("http://") || lowerCaseWord.startsWith("www.") || lowerCaseWord.startsWith("ftp://")
|| lowerCaseWord.startsWith("https://") || lowerCaseWord.startsWith("ftps://");
}
/**
* Returns true iif this word contains all upper case characters
*
* @param word
* Description of the Parameter
* @return The upperCaseWord value
*/
private final static boolean isUpperCaseWord(String word) {
for (int i = word.length() - 1; i >= 0; i--) {
if (Character.isLowerCase(word.charAt(i))) {
return false;
}
}
return true;
}
/**
* Returns true iif this word contains mixed case characters
*
* @param word
* Description of the Parameter
* @param startsSentence
* True if this word is at the start of a sentence
* @return The mixedCaseWord value
*/
private final static boolean isMixedCaseWord(String word, boolean startsSentence) {
int strLen = word.length();
boolean isUpper = Character.isUpperCase(word.charAt(0));
// Ignore the first character if this word starts the sentence and the first
// character was upper cased, since this is normal behaviour
if (startsSentence && isUpper && strLen > 1) {
isUpper = Character.isUpperCase(word.charAt(1));
}
if (isUpper) {
for (int i = word.length() - 1; i > 0; i--) {
if (Character.isLowerCase(word.charAt(i))) {
return true;
}
}
} else {
for (int i = word.length() - 1; i > 0; i--) {
if (Character.isUpperCase(word.charAt(i))) {
return true;
}
}
}
return false;
}
/**
* This method will fire the spell check event and then handle the event action that has been selected by the user.
*
* @param tokenizer
* Description of the Parameter
* @param event
* Description of the Parameter
* @return Returns true if the event action is to cancel the current spell checking, false if the spell checking should continue
*/
protected boolean fireAndHandleEvent(WordTokenizer tokenizer, SpellCheckEvent event) {
fireSpellCheckEvent(event);
String word = event.getInvalidWord();
// Work out what to do in response to the event.
switch (event.getAction()) {
case SpellCheckEvent.INITIAL:
break;
case SpellCheckEvent.IGNORE:
break;
case SpellCheckEvent.IGNOREALL:
ignoreAll(word);
break;
case SpellCheckEvent.REPLACE:
tokenizer.replaceWord(event.getReplaceWord());
break;
case SpellCheckEvent.REPLACEALL:
String replaceAllWord = event.getReplaceWord();
if (!autoReplaceWords.containsKey(word)) {
autoReplaceWords.put(word, replaceAllWord);
}
tokenizer.replaceWord(replaceAllWord);
break;
case SpellCheckEvent.ADDTODICT:
String addWord = event.getReplaceWord();
if (!addWord.equals(word)) {
tokenizer.replaceWord(addWord);
}
userdictionary.addWord(addWord);
break;
case SpellCheckEvent.CANCEL:
return true;
default:
throw new IllegalArgumentException("Unhandled case.");
}
return false;
}
public void ignoreAll(String word) {
if (!ignoredWords.contains(word)) {
ignoredWords.addElement(word);
}
}
public void addToDictionary(String word) {
if (!userdictionary.isCorrect(word)) {
userdictionary.addWord(word);
}
}
public boolean isIgnored(String word) {
return ignoredWords.contains(word);
}
public boolean isCorrect(String word) {
if (userdictionary.isCorrect(word)) {
return true;
}
for (Enumeration<SpellDictionary> e = dictionaries.elements(); e.hasMoreElements();) {
SpellDictionary dictionary = e.nextElement();
if (dictionary.isCorrect(word)) {
return true;
}
}
return false;
}
public List<Word> getSuggestions(String word, int threshold) {
if (this.threshold != threshold && cache != null) {
this.threshold = threshold;
cache.clear();
}
ArrayList<Word> suggestions = null;
if (cache != null) {
suggestions = cache.get(word);
}
if (suggestions == null) {
suggestions = new ArrayList<Word>(50);
for (Enumeration<SpellDictionary> e = dictionaries.elements(); e.hasMoreElements();) {
SpellDictionary dictionary = e.nextElement();
if (dictionary != userdictionary) {
VectorUtility.addAll(suggestions, dictionary.getSuggestions(word, threshold), false);
}
}
if (cache != null && cache.size() < cacheSize) {
cache.put(word, suggestions);
}
}
VectorUtility.addAll(suggestions, userdictionary.getSuggestions(word, threshold), false);
suggestions.trimToSize();
return suggestions;
}
/**
* Activates a cache with the maximum number of entries set to 300
*/
public void setCache() {
setCache(300);
}
/**
* Activates a cache with specified size
*
* @param size
* - max. number of cache entries (0 to disable chache)
*/
public void setCache(int size) {
cacheSize = size;
if (size == 0) {
cache = null;
} else {
cache = new HashMap<String, ArrayList<Word>>((size + 2) / 3 * 4);
}
}
/**
* This method is called to check the spelling of the words that are returned by the WordTokenizer.
* <p>
* For each invalid word the action listeners will be informed with a new SpellCheckEvent
* </p>
*
* @param tokenizer
* Description of the Parameter
* @return Either SPELLCHECK_OK, SPELLCHECK_CANCEL or the number of errors found. The number of errors are those that are found BEFORE
* any corrections are made.
*/
public final int checkSpelling(WordTokenizer tokenizer) {
int errors = 0;
boolean terminated = false;
// Keep track of the previous word
// String previousWord = null;
while (tokenizer.hasMoreWords() && !terminated) {
String word = tokenizer.nextWord();
// Check the spelling of the word
if (!isCorrect(word)) {
if (config.getBoolean(Configuration.SPELL_IGNOREMIXEDCASE) && isMixedCaseWord(word, tokenizer.isNewSentence())
|| config.getBoolean(Configuration.SPELL_IGNOREUPPERCASE) && isUpperCaseWord(word)
|| config.getBoolean(Configuration.SPELL_IGNOREDIGITWORDS) && isDigitWord(word)
|| config.getBoolean(Configuration.SPELL_IGNOREINTERNETADDRESSES) && isINETWord(word)) {
// Null event. Since we are ignoring this word due
// to one of the above cases.
} else {
// We cant ignore this misspelt word
// For this invalid word are we ignoring the misspelling?
if (!isIgnored(word)) {
errors++;
// Is this word being automagically replaced
if (autoReplaceWords.containsKey(word)) {
tokenizer.replaceWord(autoReplaceWords.get(word));
} else {
// JMH Need to somehow capitalise the suggestions if
// ignoreSentenceCapitalisation is not set to true
// Fire the event.
List<Word> suggestions = getSuggestions(word, config.getInteger(Configuration.SPELL_THRESHOLD));
if (capitalizeSuggestions(word, tokenizer)) {
suggestions = makeSuggestionsCapitalized(suggestions);
}
SpellCheckEvent event = new BasicSpellCheckEvent(word, suggestions, tokenizer);
terminated = fireAndHandleEvent(tokenizer, event);
}
}
}
} else {
// This is a correctly spelt word. However perform some extra checks
/*
* JMH TBD //Check for multiple words
* if (!ignoreMultipleWords &&) {
* }
*/
// Check for capitalisation
if (isSupposedToBeCapitalized(word, tokenizer)) {
errors++;
StringBuffer buf = new StringBuffer(word);
buf.setCharAt(0, Character.toUpperCase(word.charAt(0)));
Vector<Word> suggestion = new Vector<Word>();
suggestion.addElement(new Word(buf.toString(), 0));
SpellCheckEvent event = new BasicSpellCheckEvent(word, suggestion, tokenizer);
terminated = fireAndHandleEvent(tokenizer, event);
}
}
}
if (terminated) {
return SPELLCHECK_CANCEL;
} else if (errors == 0) {
return SPELLCHECK_OK;
} else {
return errors;
}
}
private List<Word> makeSuggestionsCapitalized(List<Word> suggestions) {
Iterator<Word> iterator = suggestions.iterator();
while (iterator.hasNext()) {
Word word = iterator.next();
String suggestion = word.getWord();
StringBuffer stringBuffer = new StringBuffer(suggestion);
stringBuffer.setCharAt(0, Character.toUpperCase(suggestion.charAt(0)));
word.setWord(stringBuffer.toString());
}
return suggestions;
}
private boolean isSupposedToBeCapitalized(String word, WordTokenizer wordTokenizer) {
boolean configCapitalize = !config.getBoolean(Configuration.SPELL_IGNORESENTENCECAPITALIZATION);
return configCapitalize && wordTokenizer.isNewSentence() && Character.isLowerCase(word.charAt(0));
}
private boolean capitalizeSuggestions(String word, WordTokenizer wordTokenizer) {
// if SPELL_IGNORESENTENCECAPITALIZATION and the initial word is capitalized, suggestions should also be capitalized
// if !SPELL_IGNORESENTENCECAPITALIZATION, capitalize suggestions only for the first word in a sentence
boolean configCapitalize = !config.getBoolean(Configuration.SPELL_IGNORESENTENCECAPITALIZATION);
boolean uppercase = Character.isUpperCase(word.charAt(0));
return configCapitalize && wordTokenizer.isNewSentence() || !configCapitalize && uppercase;
}
}