Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

javadoc fixes 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@178880 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Daniel Naber 2005-05-28 19:21:49 +00:00
parent 06bb3230ff
commit fe52019614
4 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
contrib/spellchecker/src/java/org/apache/lucene/search/spell/LuceneDictionary.java
View File

@ -26,7 +26,7 @@ import org.apache.lucene.index.Term;
import java.io.*; import java.io.*;
/** /**
* Lucene Dictionnary * Lucene Dictionary
* *
* @author Nicolas Maisonneuve * @author Nicolas Maisonneuve
*/ */

11
contrib/spellchecker/src/java/org/apache/lucene/search/spell/PlainTextDictionary.java
View File

@ -25,11 +25,12 @@ import java.io.*;
/** /**
* dictionary represented by a file text * Dictionary represented by a file text.
* Format allowed: 1 word per line: *
* word1 * <p>Format allowed: 1 word per line:<br>
* word2 * word1<br>
* word3 * word2<br>
* word3<br>
* *
* @author Nicolas Maisonneuve * @author Nicolas Maisonneuve
*/ */

35
contrib/spellchecker/src/java/org/apache/lucene/search/spell/SpellChecker.java
View File

@ -42,15 +42,16 @@ import java.util.*;
* (initially inspired by the David Spencer code). * (initially inspired by the David Spencer code).
* </p> * </p>
* *
* <p> * <p>Example Usage:
* Spell Checker spellchecker= new SpellChecker (spellDirectory);<br/> *
* <br/> * <pre>
* //To index a field of a user index <br/> * SpellChecker spellchecker = new SpellChecker(spellIndexDirectory);
* spellchecker.indexDictionary(new LuceneDictionary(my_lucene_reader, a_field));<br/> * // To index a field of a user index:
*<br/> * spellchecker.indexDictionary(new LuceneDictionary(my_lucene_reader, a_field));
* //To index a file containing words <br/> * // To index a file containing words:
* spellchecker.indexDictionary(new PlainTextDictionary(new File("myfile.txt")));<br/> * spellchecker.indexDictionary(new PlainTextDictionary(new File("myfile.txt")));
*</p> * String[] suggestions = spellchecker.suggestSimilar("misspelt", 5);
* </pre>
* *
* @author Nicolas Maisonneuve * @author Nicolas Maisonneuve
* @version 1.0 * @version 1.0
@ -83,8 +84,7 @@ public class SpellChecker {
/** /**
* Set the accuraty 0<min<1 default 0.5 * Set the accuracy 0 &lt; min &lt; 1; default 0.5
* @param min float
*/ */
public void setAccuraty (float min) { public void setAccuraty (float min) {
this.min=min; this.min=min;
@ -109,17 +109,17 @@ public class SpellChecker {
/** /**
* Suggest similar words (restricted or not of a field of a user index) * Suggest similar words (restricted or not to a field of a user index)
* @param word String the word you want a spell check done on * @param word String the word you want a spell check done on
* @param num_sug int the number of suggest words * @param num_sug int the number of suggest words
* @param ir the indexReader of the user index (can be null see field param) * @param ir the indexReader of the user index (can be null see field param)
* @param field String the field of the user index: if field is not null ,the suggest * @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. * words are restricted to the words present in this field.
* @param morePopular boolean return only the suggest words that are more frequent than the searched word * @param morePopular boolean return only the suggest words that are more frequent than the searched word
* (only if restricted mode = (indexReader!=null and field!=null) * (only if restricted mode = (indexReader!=null and field!=null)
* @throws IOException * @throws IOException
* @return String[] the sorted list of the suggest words with this 2 criteri * @return 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 * first criteria: the edit distance, second criteria (only if restricted mode): the popularity
* of the suggest words in the field of the user index * of the suggest words in the field of the user index
*/ */
public String[] suggestSimilar (String word, int num_sug, IndexReader ir, String field public String[] suggestSimilar (String word, int num_sug, IndexReader ir, String field
@ -249,10 +249,10 @@ public class SpellChecker {
/** /**
* if the word exist in the index * Check whether the word exists in the index.
* @param word String * @param word String
* @throws IOException * @throws IOException
* @return boolean * @return true iff the word exists in the index
*/ */
public boolean exist (String word) throws IOException { public boolean exist (String word) throws IOException {
if (reader==null) { if (reader==null) {
@ -319,7 +319,6 @@ public class SpellChecker {
return 3; return 3;
} }
return 2; return 2;
} }

4
contrib/spellchecker/src/java/org/apache/lucene/search/spell/SuggestWord.java
View File

@ -18,8 +18,8 @@ package org.apache.lucene.search.spell;
*/ */
/** /**
* SuggestWord Class * SuggestWord Class, used in suggestSimilar method in SpellChecker class.
* used in suggestSimilat method in SpellChecker class *
* @author Nicolas Maisonneuve * @author Nicolas Maisonneuve
*/ */
final class SuggestWord { final class SuggestWord {