org.compass.core.lucene
Class LuceneEnvironment.Analyzer

java.lang.Object
  org.compass.core.lucene.LuceneEnvironment.Analyzer

Enclosing class:

LuceneEnvironment

public abstract static class LuceneEnvironment.Analyzer
extends Object

A set of configuration settings for analyzers.

Nested Class Summary

class	LuceneEnvironment.Analyzer.CoreTypes
class	LuceneEnvironment.Analyzer.ExtendedTypes
class	LuceneEnvironment.Analyzer.Snowball

Field Summary

static String	DEFAULT_GROUP The default anayzer group that must be set.
static String	FACTORY The fully qualified name of the anayzer factory.
static String	FILTERS A comma separated list of filter names to be applied to the analyzer.
static String	PREFIX The prefix used for analyzer groups.
static String	SEARCH_GROUP An optional analyzer group name that can be set, will be used when searching.
static String	STOPWORDS A comma separated list of stop words to use with the chosen analyzer.
static String	TYPE The name of the analyzer to use, can be ANALYZER_WHITESPACE, ANALYZER_STANDARD, ANALYZER_SIMPLE, ANALYZER_STOP, a fully qualified class of the analyzer (LuceneEnvironment.Analyzer or an instnace of it.

Constructor Summary

LuceneEnvironment.Analyzer()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFIX

public static final String PREFIX

The prefix used for analyzer groups.

See Also:

Constant Field Values

DEFAULT_GROUP

public static final String DEFAULT_GROUP

The default anayzer group that must be set.

See Also:

Constant Field Values

SEARCH_GROUP

public static final String SEARCH_GROUP

An optional analyzer group name that can be set, will be used when searching.

See Also:

Constant Field Values

TYPE

public static final String TYPE

The name of the analyzer to use, can be ANALYZER_WHITESPACE, ANALYZER_STANDARD, ANALYZER_SIMPLE, ANALYZER_STOP, a fully qualified class of the analyzer (LuceneEnvironment.Analyzer or an instnace of it.

It is part of the anaylzer group, and should be constructed using the CompassSettings.setGroupSettings(String,String,String[],Object[]), with the PREFIX as the prefix, the analyzer group name, and the type as one of the values.

See Also:

Constant Field Values

FACTORY

public static final String FACTORY

The fully qualified name of the anayzer factory. Must implement the LuceneAnalyzerFactory inteface.

It is part of the anaylzer group, and should be constructed using the CompassSettings.setGroupSettings(String,String,String[],Object[]), with the PREFIX as the prefix, the analyzer group name, and the type as one of the values.

See Also:

Constant Field Values

STOPWORDS

public static final String STOPWORDS

A comma separated list of stop words to use with the chosen analyzer. If the string starts with +, the list of stop-words will be added to the default set of stop words defined for the analyzer. Only supported for the default analyzers that comes with Compass.

It is part of the anaylzer group, and should be constructed using the CompassSettings.setGroupSettings(String,String,String[],Object[]), with the PREFIX as the prefix, the analyzer group name, and the stopwords as one of the values.

See Also:

Constant Field Values

FILTERS

public static final String FILTERS

A comma separated list of filter names to be applied to the analyzer. The names match LuceneAnalyzerTokenFilterProviders configured using the LuceneEnvironment.AnalyzerFilter configuration settings.

See Also:

Constant Field Values

Constructor Detail

LuceneEnvironment.Analyzer

public LuceneEnvironment.Analyzer()