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


org.compass.annotations.SearchAnalyzer

SearchAnalyzer
public @interface SearchAnalyzer(Code)
Configure Analyzer to be used within Compass. Set on package definition (package-info.java).

The Analyzer is registed under a lookup name ( SearchAnalyzer.name() ), which can then be reference in the different mapping definitions.

Allows for simple configuration of all analyzers that come with Compass using SearchAnalyzer.type() . If the SearchAnalyzer.type() is set to AnalyzerType.Snowball , the SearchAnalyzer.snowballType() can be used to further configure the snowball analyzer. If a custom converter needs to be registered with Compass, the AnalyzerType.CustomAnalyzer needs to be set on SearchAnalyzer.type() , and the SearchAnalyzer.analyzerClass() needs to be configured with the class that implements it.

A set of stop words can be added/replace the stop words the internal analyzers are configured with. The stop words will be added if the SearchAnalyzer.addStopWords() is set to true.

Further settings can be set for a specialized analyzer using SearchAnalyzer.settings() . If the specialized Analyzer requires settings to be injected, it needs to implement the org.compass.core.config.CompassConfigurable interface.

To replace Compas default analyzer, the SearchAnalyzer.name() should be set org.compass.core.lucene.LuceneEnvironment.Analyzer.DEFAULT_GROUP .

To replace Compass search analyzer (which defaults to the default analyzer if not set), the SearchAnalyzer.name() should be set to org.compass.core.lucene.LuceneEnvironment.Analyzer.SEARCH_GROUP .

Multiple analyzers can be defined using the SearchAnalyzers annotation.

Note, that Analyzers can also be conifugred using Compass configuration mechanism.
author:
   kimchy



Field Summary
 booleanaddStopWords
     Add the set of SearchAnalyzer.stopWords() to the default set of stop words if set to true.
 Class<? extends Analyzer>analyzerClass
     The custom Analyzer implementation.
 String[]filters
     A set of org.compass.core.lucene.engine.analyzer.LuceneAnalyzerTokenFilterProvider s lookup names to be used with the Analyzer .
 Stringname
     The name the analyzer will be registered under.
 SearchSetting[]settings
     Futher settings for a custom Analyzer implementation.
 SnowballTypesnowballType
     If the SearchAnalyzer.type() is set to AnalyzerType.Snowball , controls the snowball analyzer type.
 String[]stopWords
     A set of stop words that will be added/replace the stop words that comes with Compass intenral analyzers.
 AnalyzerTypetype
     The type of the analyzer.



Field Detail
addStopWords
boolean addStopWords(Code)
Add the set of SearchAnalyzer.stopWords() to the default set of stop words if set to true. Replaces them if set to false.

Only applies when using one of Compass internal analyzer types, and not the AnalyzerType.CustomAnalyzer .




analyzerClass
Class<? extends Analyzer> analyzerClass(Code)
The custom Analyzer implementation. Used when the SearchAnalyzer.type() is set to AnalyzerType.CustomAnalyzer .



filters
String[] filters(Code)
A set of org.compass.core.lucene.engine.analyzer.LuceneAnalyzerTokenFilterProvider s lookup names to be used with the Analyzer .

Filters can be configured using SearchAnalyzerFilter or using Compass configuration.




name
String name(Code)
The name the analyzer will be registered under.



settings
SearchSetting[] settings(Code)
Futher settings for a custom Analyzer implementation.



snowballType
SnowballType snowballType(Code)
If the SearchAnalyzer.type() is set to AnalyzerType.Snowball , controls the snowball analyzer type.



stopWords
String[] stopWords(Code)
A set of stop words that will be added/replace the stop words that comes with Compass intenral analyzers.

Only applies when using one of Compass internal analyzer types, and not the AnalyzerType.CustomAnalyzer .




type
AnalyzerType type(Code)
The type of the analyzer. For custom Analyzer implementation the AnalyzerType.CustomAnalyzer should be set, and the SearchAnalyzer.analyzerClass() should have the custom Analyzer class set.





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