Lucene Analyzer

Identifier:
org.eclipse.help.base.luceneAnalyzer

Since:
3.0 (originally added in release 2.0 as org.eclipse.help.luceneAnalyzer)

Description:
This extension point is used to register text analyzers for use by help when indexing and searching documentation.

Help exploits capabilities of the Lucene search engine, that allows indexing of token streams (streams of words). Analyzers create tokens from the character stream. They examine text content and provide tokens for use with the index. The text stream can be tokenized in many unique ways. A trivial analyzer can tokenize streams at white space, a different one can perform filtering of tokens, based on the application needs. Since the documentation is mostly human-readable text, it is desired that analyzers used by the help system perform language and grammar aware tokenization and normalization of indexed text. For some languages, the quality of search increases significantly if stop word removal and stemming is performed on the indexed text.

The analyzer contributed to this extension point will override the one provided by the Eclipse help system for a given locale.

Configuration Markup:

<!ELEMENT extension (analyzer*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

>


<!ELEMENT analyzer EMPTY>

<!ATTLIST analyzer

locale CDATA #REQUIRED

class  CDATA #REQUIRED

>


Examples:
Following is an example of Lucene Analyzer configuration:


 <extension id="com.xyx.XYZ" point="org.eclipse.help.base.luceneAnalyzer">
  <analyzer locale="ll_CC" class="com.xyz.ll_CCAnalyzer"/>
 </extension>

API Information:
The value of the locale attribute must represent either a five- or two-charcter locale string. If the analyzer is configured for a language by specifying two-letter language designation, the analyzer is going to be used for all locales of this language. If the analyzer is configured that matchs a five-character locale, it is going to be used instead.

The value of the class attribute must represent a class that extends org.apache.lucene.analysis.Analyzer. It is recommended that this analyzer performs lowercase filtering for languages where it is possible to increase number of search hits by making search case-sensitive.

Supplied Implementation:
The Eclipse help system provides analyzers for all languages. For English and German, the analyzers perform stop word filtering, lowercase filtering, and stemming. For all the other languages the supplied analyzer only performs lowercase filtering.


Copyright (c) 2000, 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html