org.apache.lucene.search.spell
Class SpellChecker
public class SpellChecker
Spell Checker class (Main class)
(initially inspired by the David Spencer code).
Example Usage:
SpellChecker spellchecker = new SpellChecker(spellIndexDirectory);
// To index a field of a user index:
spellchecker.indexDictionary(new LuceneDictionary(my_lucene_reader, a_field));
// To index a file containing words:
spellchecker.indexDictionary(new PlainTextDictionary(new File("myfile.txt")));
String[] suggestions = spellchecker.suggestSimilar("misspelt", 5);
static String | F_WORD - Field name for each word in the ngram index.
|
F_WORD
public static final String F_WORD
Field name for each word in the ngram index.
SpellChecker
public SpellChecker(Directory spellIndex)
throws IOException
clearIndex
public void clearIndex()
throws IOException
exist
public boolean exist(String word)
throws IOException
Check whether the word exists in the index.
- true iff the word exists in the index
finalize
protected void finalize()
throws Throwable
indexDictionary
public void indexDictionary(Dictionary dict)
throws IOException
Index a Dictionary
dict
- the dictionary to index
setAccuracy
public void setAccuracy(float min)
Sets the accuracy 0 < minScore < 1; default 0.5
setSpellIndex
public void setSpellIndex(Directory spellIndex)
throws IOException
suggestSimilar
public String[] suggestSimilar(String word,
int numSug)
throws IOException
Suggest similar words
word
- String the word you want a spell check done onnumSug
- int the number of suggest words
suggestSimilar
public String[] suggestSimilar(String word,
int numSug,
IndexReader ir,
String field,
boolean morePopular)
throws IOException
Suggest similar words (restricted or not to a field of a user index)
word
- String the word you want a spell check done onnumSug
- int the number of suggest wordsir
- the indexReader of the user index (can be null see field param)field
- String the field of the user index: if field is not null, the suggested
words are restricted to the words present in this field.morePopular
- boolean return only the suggest words that are more frequent than the searched word
(only if restricted mode = (indexReader!=null and field!=null)
- String[] the sorted list of the suggest words with this 2 criteria:
first criteria: the edit distance, second criteria (only if restricted mode): the popularity
of the suggest words in the field of the user index
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.