com.rondhuit.solr.spell

クラス SpellChecker

java.lang.Object

com.rondhuit.solr.spell.SpellChecker

すべての実装されたインタフェース:

java.io.Closeable, java.lang.AutoCloseable

public class SpellChecker
extends java.lang.Object
implements java.io.Closeable

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);
 

導入されたバージョン:

0.9

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static float	DEFAULT_ACCURACY The default minimum score to use, if not specified by calling setAccuracy(float) .
static java.lang.String	F_SUGGEST Field name for each word in the ngram index.
static java.lang.String	F_WORD

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SpellChecker(Directory spellIndex) Use the given directory as a spell checker index with a LevensteinDistance as the default StringDistance.
SpellChecker(Directory spellIndex, org.apache.lucene.search.spell.StringDistance sd) Use the given directory as a spell checker index.
SpellChecker(Directory spellIndex, org.apache.lucene.search.spell.StringDistance sd, java.util.Comparator<org.apache.lucene.search.spell.SuggestWord> comparator) Use the given directory as a spell checker index with the given StringDistance measure and the given Comparator for sorting the results.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	clearIndex() Removes all terms from the spell check index.
void	close() Close the IndexSearcher used by this SpellChecker
boolean	exist(java.lang.String word) Check whether the word exists in the index.
float	getAccuracy() The accuracy (minimum score) to be used, unless overridden in suggestSimilar(String, int, org.apache.lucene.index.IndexReader, String, boolean, float), to decide whether a suggestion is included or not.
java.util.Comparator<org.apache.lucene.search.spell.SuggestWord>	getComparator()
org.apache.lucene.search.spell.StringDistance	getStringDistance() Returns the StringDistance instance used by this SpellChecker instance.
Analyzer	getWordAnalyzer()
void	indexDictionary(org.apache.lucene.search.spell.Dictionary dict, IndexWriterConfig config, boolean fullMerge) Indexes the data from the given Dictionary.
void	setAccuracy(float acc) Sets the accuracy 0 < minScore < 1; default DEFAULT_ACCURACY
void	setComparator(java.util.Comparator<org.apache.lucene.search.spell.SuggestWord> comparator) Sets the Comparator for the SuggestWordQueue.
void	setSpellIndex(Directory spellIndexDir) Use a different index as the spell checker index or re-open the existing index if spellIndex is the same value as given in the constructor.
void	setStringDistance(org.apache.lucene.search.spell.StringDistance sd) Sets the StringDistance implementation for this SpellChecker instance.
void	setWordAnalyzer(Analyzer wordAnalyzer)
java.lang.String[]	suggestSimilar(java.lang.String target, int numSug) Suggest similar words.
java.lang.String[]	suggestSimilar(java.lang.String target, int numSug, float accuracy) Suggest similar words.
java.lang.String[]	suggestSimilar(java.lang.String target, int numSug, IndexReader ir, java.lang.String field, boolean morePopular) 非推奨です。 use suggestSimilar(String, int, IndexReader, String, SuggestMode) SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX instead of morePopular=false SuggestMode.SuGGEST_MORE_POPULAR instead of morePopular=true
java.lang.String[]	suggestSimilar(java.lang.String target, int numSug, IndexReader ir, java.lang.String field, boolean morePopular, float accuracy) 非推奨です。 use suggestSimilar(String, int, IndexReader, String, SuggestMode, float) SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX instead of morePopular=false SuggestMode.SuGGEST_MORE_POPULAR instead of morePopular=true
java.lang.String[]	suggestSimilar(java.lang.String target, int numSug, IndexReader ir, java.lang.String field, org.apache.lucene.search.spell.SuggestMode suggestMode) Calls suggestSimilar(word, numSug, ir, suggestMode, field, this.accuracy)
java.lang.String[]	suggestSimilar(java.lang.String target, int numSug, IndexReader ir, java.lang.String field, org.apache.lucene.search.spell.SuggestMode suggestMode, float accuracy) Suggest similar words (optionally restricted to a field of an index).

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

DEFAULT_ACCURACY

public static final float DEFAULT_ACCURACY

The default minimum score to use, if not specified by calling setAccuracy(float) .

関連項目:

定数フィールド値

F_SUGGEST

public static final java.lang.String F_SUGGEST

Field name for each word in the ngram index.

関連項目:

定数フィールド値

F_WORD

public static final java.lang.String F_WORD

関連項目:

定数フィールド値

コンストラクタの詳細

SpellChecker

public SpellChecker(Directory spellIndex,
                    org.apache.lucene.search.spell.StringDistance sd)
             throws java.io.IOException

Use the given directory as a spell checker index. The directory is created if it doesn't exist yet.

パラメータ:

spellIndex - the spell index directory

sd - the StringDistance measurement to use

例外:

java.io.IOException - if Spellchecker can not open the directory

SpellChecker

public SpellChecker(Directory spellIndex)
             throws java.io.IOException

Use the given directory as a spell checker index with a LevensteinDistance as the default StringDistance. The directory is created if it doesn't exist yet.

パラメータ:

spellIndex - the spell index directory

例外:

java.io.IOException - if spellchecker can not open the directory

SpellChecker

public SpellChecker(Directory spellIndex,
                    org.apache.lucene.search.spell.StringDistance sd,
                    java.util.Comparator<org.apache.lucene.search.spell.SuggestWord> comparator)
             throws java.io.IOException

Use the given directory as a spell checker index with the given StringDistance measure and the given Comparator for sorting the results.

パラメータ:

spellIndex - The spelling index

sd - The distance

comparator - The comparator

例外:

java.io.IOException - if there is a problem opening the index

メソッドの詳細

setSpellIndex

public void setSpellIndex(Directory spellIndexDir)
                   throws java.io.IOException

Use a different index as the spell checker index or re-open the existing index if spellIndex is the same value as given in the constructor.

パラメータ:

spellIndexDir - the spell directory to use

例外:

AlreadyClosedException - if the Spellchecker is already closed

java.io.IOException - if spellchecker can not open the directory

setComparator

public void setComparator(java.util.Comparator<org.apache.lucene.search.spell.SuggestWord> comparator)

Sets the Comparator for the SuggestWordQueue.

パラメータ:

comparator - the comparator

getComparator

public java.util.Comparator<org.apache.lucene.search.spell.SuggestWord> getComparator()

setStringDistance

public void setStringDistance(org.apache.lucene.search.spell.StringDistance sd)

Sets the StringDistance implementation for this SpellChecker instance.

パラメータ:

sd - the StringDistance implementation for this SpellChecker instance

getStringDistance

public org.apache.lucene.search.spell.StringDistance getStringDistance()

Returns the StringDistance instance used by this SpellChecker instance.

戻り値:

the StringDistance instance used by this SpellChecker instance.

setAccuracy

public void setAccuracy(float acc)

Sets the accuracy 0 < minScore < 1; default DEFAULT_ACCURACY

パラメータ:

acc - The new accuracy

getAccuracy

public float getAccuracy()

The accuracy (minimum score) to be used, unless overridden in suggestSimilar(String, int, org.apache.lucene.index.IndexReader, String, boolean, float), to decide whether a suggestion is included or not.

戻り値:

The current accuracy setting

setWordAnalyzer

public void setWordAnalyzer(Analyzer wordAnalyzer)

getWordAnalyzer

public Analyzer getWordAnalyzer()

suggestSimilar

public java.lang.String[] suggestSimilar(java.lang.String target,
                                         int numSug)
                                  throws java.io.IOException

Suggest similar words.

As the Lucene similarity that is used to fetch the most relevant n-grammed terms is not the same as the edit distance strategy used to calculate the best matching spell-checked word from the hits that Lucene found, one usually has to retrieve a couple of numSug's in order to get the true best match.

I.e. if numSug == 1, don't count on that suggestion being the best one. Thus, you should set this value to at least 5 for a good suggestion.

パラメータ:

target - the word you want a spell check done on

numSug - the number of suggested words

戻り値:

String[]

例外:

java.io.IOException - if the underlying index throws an IOException

AlreadyClosedException - if the Spellchecker is already closed

関連項目:

suggestSimilar(String, int, org.apache.lucene.index.IndexReader, String, boolean, float)

suggestSimilar

public java.lang.String[] suggestSimilar(java.lang.String target,
                                         int numSug,
                                         float accuracy)
                                  throws java.io.IOException

Suggest similar words.

As the Lucene similarity that is used to fetch the most relevant n-grammed terms is not the same as the edit distance strategy used to calculate the best matching spell-checked word from the hits that Lucene found, one usually has to retrieve a couple of numSug's in order to get the true best match.

I.e. if numSug == 1, don't count on that suggestion being the best one. Thus, you should set this value to at least 5 for a good suggestion.

パラメータ:

target - the word you want a spell check done on

numSug - the number of suggested words

accuracy - The minimum score a suggestion must have in order to qualify for inclusion in the results

戻り値:

String[]

例外:

java.io.IOException - if the underlying index throws an IOException

AlreadyClosedException - if the Spellchecker is already closed

関連項目:

suggestSimilar(String, int, org.apache.lucene.index.IndexReader, String, boolean, float)

suggestSimilar

@Deprecated
public java.lang.String[] suggestSimilar(java.lang.String target,
                                                     int numSug,
                                                     IndexReader ir,
                                                     java.lang.String field,
                                                     boolean morePopular)
                                              throws java.io.IOException

非推奨です。 use suggestSimilar(String, int, IndexReader, String, SuggestMode)

• SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX instead of morePopular=false
• SuggestMode.SuGGEST_MORE_POPULAR instead of morePopular=true

Suggest similar words (optionally restricted to a field of an index).

As the Lucene similarity that is used to fetch the most relevant n-grammed terms is not the same as the edit distance strategy used to calculate the best matching spell-checked word from the hits that Lucene found, one usually has to retrieve a couple of numSug's in order to get the true best match.

I.e. if numSug == 1, don't count on that suggestion being the best one. Thus, you should set this value to at least 5 for a good suggestion.

Uses the getAccuracy() value passed into the constructor as the accuracy.

パラメータ:

target - the word you want a spell check done on

numSug - the number of suggested words

ir - the indexReader of the user index (can be null see field param)

field - the field of the user index: if field is not null, the suggested words are restricted to the words present in this field.

morePopular - return only the suggest words that are as frequent or more frequent than the searched word (only if restricted mode = (indexReader!=null and field!=null)

戻り値:

String[] the sorted list of the suggest words with these 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

例外:

java.io.IOException - if the underlying index throws an IOException

AlreadyClosedException - if the Spellchecker is already closed

関連項目:

suggestSimilar(String, int, IndexReader, String, SuggestMode, float)

suggestSimilar

@Deprecated
public java.lang.String[] suggestSimilar(java.lang.String target,
                                                     int numSug,
                                                     IndexReader ir,
                                                     java.lang.String field,
                                                     boolean morePopular,
                                                     float accuracy)
                                              throws java.io.IOException

非推奨です。 use suggestSimilar(String, int, IndexReader, String, SuggestMode, float)

• SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX instead of morePopular=false
• SuggestMode.SuGGEST_MORE_POPULAR instead of morePopular=true

Suggest similar words (optionally restricted to a field of an index).

As the Lucene similarity that is used to fetch the most relevant n-grammed terms is not the same as the edit distance strategy used to calculate the best matching spell-checked word from the hits that Lucene found, one usually has to retrieve a couple of numSug's in order to get the true best match.

I.e. if numSug == 1, don't count on that suggestion being the best one. Thus, you should set this value to at least 5 for a good suggestion.

パラメータ:

target - the word you want a spell check done on

numSug - the number of suggested words

ir - the indexReader of the user index (can be null see field param)

field - the field of the user index: if field is not null, the suggested words are restricted to the words present in this field.

morePopular - return only the suggest words that are as frequent or more frequent than the searched word (only if restricted mode = (indexReader!=null and field!=null)

accuracy - The minimum score a suggestion must have in order to qualify for inclusion in the results

戻り値:

String[] the sorted list of the suggest words with these 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

例外:

java.io.IOException - if the underlying index throws an IOException

AlreadyClosedException - if the Spellchecker is already closed

関連項目:

suggestSimilar(String, int, IndexReader, String, SuggestMode, float)

suggestSimilar

public java.lang.String[] suggestSimilar(java.lang.String target,
                                         int numSug,
                                         IndexReader ir,
                                         java.lang.String field,
                                         org.apache.lucene.search.spell.SuggestMode suggestMode)
                                  throws java.io.IOException

Calls suggestSimilar(word, numSug, ir, suggestMode, field, this.accuracy)

例外:

java.io.IOException

suggestSimilar

public java.lang.String[] suggestSimilar(java.lang.String target,
                                         int numSug,
                                         IndexReader ir,
                                         java.lang.String field,
                                         org.apache.lucene.search.spell.SuggestMode suggestMode,
                                         float accuracy)
                                  throws java.io.IOException

Suggest similar words (optionally restricted to a field of an index).

As the Lucene similarity that is used to fetch the most relevant n-grammed terms is not the same as the edit distance strategy used to calculate the best matching spell-checked word from the hits that Lucene found, one usually has to retrieve a couple of numSug's in order to get the true best match.

I.e. if numSug == 1, don't count on that suggestion being the best one. Thus, you should set this value to at least 5 for a good suggestion.

パラメータ:

target - the word you want a spell check done on

numSug - the number of suggested words

ir - the indexReader of the user index (can be null see field param)

field - the field of the user index: if field is not null, the suggested words are restricted to the words present in this field.

suggestMode - (NOTE: if indexReader==null and/or field==null, then this is overridden with SuggestMode.SUGGEST_ALWAYS)

accuracy - The minimum score a suggestion must have in order to qualify for inclusion in the results

戻り値:

String[] the sorted list of the suggest words with these 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

例外:

java.io.IOException - if the underlying index throws an IOException

AlreadyClosedException - if the Spellchecker is already closed

clearIndex

public void clearIndex()
                throws java.io.IOException

Removes all terms from the spell check index.

例外:

java.io.IOException

AlreadyClosedException - if the Spellchecker is already closed

exist

public boolean exist(java.lang.String word)
              throws java.io.IOException

Check whether the word exists in the index.

パラメータ:

word -

戻り値:

true if the word exists in the index

例外:

java.io.IOException

AlreadyClosedException - if the Spellchecker is already closed

indexDictionary

public final void indexDictionary(org.apache.lucene.search.spell.Dictionary dict,
                                  IndexWriterConfig config,
                                  boolean fullMerge)
                           throws java.io.IOException

Indexes the data from the given Dictionary.

パラメータ:

dict - Dictionary to index

config - IndexWriterConfig to use

fullMerge - whether or not the spellcheck index should be fully merged

例外:

AlreadyClosedException - if the Spellchecker is already closed

java.io.IOException

close

public void close()
           throws java.io.IOException

Close the IndexSearcher used by this SpellChecker

定義:

close インタフェース内 java.io.Closeable

定義:

close インタフェース内 java.lang.AutoCloseable

例外:

java.io.IOException - if the close operation causes an IOException

AlreadyClosedException - if the SpellChecker is already closed