org.compass.annotations
Annotation Type SearchAnalyzerFilter


@Target(value=PACKAGE)
@Retention(value=RUNTIME)
public @interface SearchAnalyzerFilter

Configures a LuceneAnalyzerTokenFilterProvider to be used within Compass. Set on package definition (package-info.java).

The LuceneAnalyzerTokenFilterProvider is registed under a lookup name (name()), which can then be reference in in the analyzer definition (i.e. SearchAnalyzer.filters()).

Additional settings can be injected into the LuceneAnalyzerTokenFilterProvider implementation using settings().

Author:
kimchy
See Also:
LuceneAnalyzerTokenFilterProvider, SynonymAnalyzerTokenFilterProvider

Required Element Summary
 String name
          The name the analyzer token filter provider will be registered under.
 Class<? extends LuceneAnalyzerTokenFilterProvider> type
          The LuceneAnalyzerTokenFilterProvider implementation.
 
Optional Element Summary
 SearchSetting[] settings
          Additional settings for the LuceneAnalyzerTokenFilterProvider implementation.
 

Element Detail

name

public abstract String name
The name the analyzer token filter provider will be registered under.


type

public abstract Class<? extends LuceneAnalyzerTokenFilterProvider> type
The LuceneAnalyzerTokenFilterProvider implementation.

settings

public abstract SearchSetting[] settings
Additional settings for the LuceneAnalyzerTokenFilterProvider implementation.

Default:
{}


Copyright (c) 2004-2008 The Compass Project.