org.compass.core.lucene.engine.analyzer.synonym
Class SynonymAnalyzerTokenFilterProvider

java.lang.Object
  extended by org.compass.core.lucene.engine.analyzer.synonym.SynonymAnalyzerTokenFilterProvider
All Implemented Interfaces:
CompassConfigurable, LuceneAnalyzerTokenFilterProvider

public class SynonymAnalyzerTokenFilterProvider
extends Object
implements LuceneAnalyzerTokenFilterProvider

A synonym analyzer token filter provider. Uses the SynonymFilter to return synonyms. The SynonymFilter in turn uses the SynonymLookupProvider which should be provided in order to lookup synonyms for a given value.

Author:
kimchy
See Also:
SynonymFilter, SynonymLookupProvider

Constructor Summary
SynonymAnalyzerTokenFilterProvider()
           
 
Method Summary
 void configure(CompassSettings settings)
          Configure using the given settings.
 TokenFilter createTokenFilter(TokenStream tokenStream)
          Creates a new token filter based on the token stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SynonymAnalyzerTokenFilterProvider

public SynonymAnalyzerTokenFilterProvider()
Method Detail

configure

public void configure(CompassSettings settings)
               throws CompassException
Description copied from interface: CompassConfigurable
Configure using the given settings.

Specified by:
configure in interface CompassConfigurable
Parameters:
settings - The settings for the configured object
Throws:
CompassException

createTokenFilter

public TokenFilter createTokenFilter(TokenStream tokenStream)
Description copied from interface: LuceneAnalyzerTokenFilterProvider
Creates a new token filter based on the token stream. Called every time an analysis should occur, so it would be nice to create any global level data during the configuration process.

Specified by:
createTokenFilter in interface LuceneAnalyzerTokenFilterProvider


Copyright (c) 2004-2009 The Compass Project.