Anthony Mckale created LUCENE-4487:
--------------------------------------
Summary: SpellChecker : SpellChecker.indexDictionary : Javadoc
incorrect
Key: LUCENE-4487
URL: https://issues.apache.org/jira/browse/LUCENE-4487
Project: Lucene - Core
Issue Type: Improvement
Components: modules/spellchecker
Affects Versions: 3.6.1
Reporter: Anthony Mckale
Priority: Minor
example code in javadoc seems to be incorrect
code changes from LUCENE-3557
means the javadoc
{code}
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);
{code}
is incorrect i think something like this is better maybe
{code}
SpellChecker spellchecker = new SpellChecker(spellIndexDirectory);
// To index a field of a user index:
spellchecker.indexDictionary(new LuceneDictionary(my_lucene_reader, a_field),
new IndexWriterConfig(Version.LUCENE_CURRENT, null), false);
// To index a file containing words:
spellchecker.indexDictionary(new PlainTextDictionary(new File("myfile.txt")),
new IndexWriterConfig(Version.LUCENE_CURRENT, null), false);
String[] suggestions = spellchecker.suggestSimilar("misspelt", 5);
{code}
I'd possibly add something about creating a spellIndexDirectory too, not clear
{code}
Directory spellIndexDirectory = FSDirectory.open("/dev/tmp/SOME_WORKING_DIR");
SpellChecker spellchecker = new SpellChecker(spellIndexDirectory);
// To index a field of a user index:
spellchecker.indexDictionary(new LuceneDictionary(my_lucene_reader, a_field),
new IndexWriterConfig(Version.LUCENE_CURRENT, null), false);
// To index a file containing words:
spellchecker.indexDictionary(new PlainTextDictionary(new File("myfile.txt")),
new IndexWriterConfig(Version.LUCENE_CURRENT, null), false);
String[] suggestions = spellchecker.suggestSimilar("misspelt", 5);
{code}
would of sent a patch but not similar with how to get access to the apache git
repo do a pull/push
cheers
Ant
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
