Java Doc for SearchEngineSpellCheckManager.java in  » Search-Engine » compass-2.0 » org » compass » core » engine » spellcheck » 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 » Search Engine » compass 2.0 » org.compass.core.engine.spellcheck 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.compass.core.engine.spellcheck.SearchEngineSpellCheckManager

SearchEngineSpellCheckManager
public interface SearchEngineSpellCheckManager (Code)
The spell check manager allows to perform spell check index level operations. It also allows to perform operations using the spell check, for example to suggest words for a given word.

The spell check manager can be configured using org.compass.core.lucene.LuceneEnvironment.SpellCheck settings.
author:
   kimchy





Method Summary
 booleanconcurrentRebuild()
    
 voidconcurrentRefresh()
     Same as SearchEngineSpellCheckManager.refresh() but executes the refresh of each sub index using Compass built in thread pool.
 voiddeleteIndex()
     Deletes the spell check index.
 voiddeleteIndex(String subIndex)
     Deletes the spell check index for the given sub index.
 booleanisRebuildNeeded()
     Returns true if a rebuild of the spell check index is required.
 booleanisRebuildNeeded(String subIndex)
     Returns true if a rebuild of the spell index for the given sub index is required.
 booleanrebuild()
     Rebuilds the spell check index.
 booleanrebuild(String subIndex)
     Rebuilds the spell check index for the given sub index.
 voidrefresh()
     Refresh the internal readers and searches that work with the spell index.
 voidrefresh(String subIndex)
     Refresh the internal readers and searches for the given sub index that work with the spell index.
 voidstart()
     Starts the spell check manager.
 voidstop()
     Stops any scheduled tasks started by the SearchEngineSpellCheckManager.start() method.
 CompassQuerysuggest(CompassQuery query)
     Suggests a query based on the given query.
 SearchEngineSpellCheckSuggestBuildersuggestBuilder(String word)
     Creates a suggest builder allowing to suggest words for the given word.



Method Detail
concurrentRebuild
boolean concurrentRebuild() throws SearchEngineException(Code)
Same as SearchEngineSpellCheckManager.rebuild() but executes the rebuild of each sub index using Compass built in thread pool



concurrentRefresh
void concurrentRefresh() throws SearchEngineException(Code)
Same as SearchEngineSpellCheckManager.refresh() but executes the refresh of each sub index using Compass built in thread pool.



deleteIndex
void deleteIndex() throws SearchEngineException(Code)
Deletes the spell check index.



deleteIndex
void deleteIndex(String subIndex) throws SearchEngineException(Code)
Deletes the spell check index for the given sub index.



isRebuildNeeded
boolean isRebuildNeeded() throws SearchEngineException(Code)
Returns true if a rebuild of the spell check index is required.



isRebuildNeeded
boolean isRebuildNeeded(String subIndex) throws SearchEngineException(Code)
Returns true if a rebuild of the spell index for the given sub index is required.



rebuild
boolean rebuild() throws SearchEngineException(Code)
Rebuilds the spell check index. Won't rebuild specific sub indexes if it is not needed.



rebuild
boolean rebuild(String subIndex) throws SearchEngineException(Code)
Rebuilds the spell check index for the given sub index. Won't rebuild if it is not needed.



refresh
void refresh() throws SearchEngineException(Code)
Refresh the internal readers and searches that work with the spell index.



refresh
void refresh(String subIndex) throws SearchEngineException(Code)
Refresh the internal readers and searches for the given sub index that work with the spell index.



start
void start()(Code)
Starts the spell check manager. Will start a scheduled task to refresh the cached searchers and readers over the spell check index. Will also schedule, if configured, a schediled rebuild of the spell check index.



stop
void stop()(Code)
Stops any scheduled tasks started by the SearchEngineSpellCheckManager.start() method.



suggest
CompassQuery suggest(CompassQuery query)(Code)
Suggests a query based on the given query. Note, if the query was replaced/sugested then the org.compass.core.CompassQuery.isSuggested flag will be set to true.



suggestBuilder
SearchEngineSpellCheckSuggestBuilder suggestBuilder(String word)(Code)
Creates a suggest builder allowing to suggest words for the given word.



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