lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Simon Willnauer (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-4487) SpellChecker : SpellChecker.indexDictionary : Javadoc incorrect
Date Wed, 17 Oct 2012 12:40:03 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-4487?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13477818#comment-13477818
] 

Simon Willnauer commented on LUCENE-4487:
-----------------------------------------

this makes lots of sense! can you upload a patch for this?

simon
                
> 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 familiar with how to get access to the apache git repo
todo 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: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message