Java Doc for SpellChecker.java in  » Net » lucene-connector » org » apache » lucene » search » spell » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » lucene connector » org.apache.lucene.search.spell 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.lucene.search.spell.SpellChecker

SpellChecker
public class SpellChecker (Code)

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

version:
   1.0


Field Summary
final public static  StringF_WORD
     Field name for each word in the ngram index.
 DirectoryspellIndex
    

Constructor Summary
public  SpellChecker(Directory spellIndex)
     Use the given directory as a spell checker index.

Method Summary
public  voidclearIndex()
     Removes all terms from the spell check index.
public  booleanexist(String word)
     Check whether the word exists in the index.
protected  voidfinalize()
     Closes the internal IndexReader.
public  voidindexDictionary(Dictionary dict)
    
public  voidsetAccuracy(float minScore)
    
public  voidsetSpellIndex(Directory spellIndex)
     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.
public  String[]suggestSimilar(String word, int numSug)
     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.

public  String[]suggestSimilar(String word, int numSug, IndexReader ir, String field, boolean morePopular)
     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.


Field Detail
F_WORD
final public static String F_WORD(Code)
Field name for each word in the ngram index.



spellIndex
Directory spellIndex(Code)
the spell index




Constructor Detail
SpellChecker
public SpellChecker(Directory spellIndex) throws IOException(Code)
Use the given directory as a spell checker index. The directory is created if it doesn't exist yet.
Parameters:
  spellIndex -
throws:
  IOException -




Method Detail
clearIndex
public void clearIndex() throws IOException(Code)
Removes all terms from the spell check index.
throws:
  IOException -



exist
public boolean exist(String word) throws IOException(Code)
Check whether the word exists in the index.
Parameters:
  word -
throws:
  IOException - true iff the word exists in the index



finalize
protected void finalize() throws Throwable(Code)
Closes the internal IndexReader.



indexDictionary
public void indexDictionary(Dictionary dict) throws IOException(Code)
Index a Dictionary
Parameters:
  dict - the dictionary to index
throws:
  IOException -



setAccuracy
public void setAccuracy(float minScore)(Code)
Sets the accuracy 0 < minScore < 1; default 0.5



setSpellIndex
public void setSpellIndex(Directory spellIndex) throws IOException(Code)
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.
Parameters:
  spellIndex -
throws:
  IOException -



suggestSimilar
public String[] suggestSimilar(String word, int numSug) throws IOException(Code)
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.
Parameters:
  word - the word you want a spell check done on
Parameters:
  numSug - the number of suggested words
throws:
  IOException - String[]




suggestSimilar
public String[] suggestSimilar(String word, int numSug, IndexReader ir, String field, boolean morePopular) throws IOException(Code)
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.
Parameters:
  word - the word you want a spell check done on
Parameters:
  numSug - the number of suggested words
Parameters:
  ir - the indexReader of the user index (can be null see field param)
Parameters:
  field - the field of the user index: if field is not null, the suggestedwords are restricted to the words present in this field.
Parameters:
  morePopular - return only the suggest words that are more frequent than the searched word(only if restricted mode = (indexReader!=null and field!=null)
throws:
  IOException - String[] the sorted list of the suggest words with these 2 criteria:first criteria: the edit distance, second criteria (only if restricted mode): the popularityof the suggest words in the field of the user index




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.