org.apache.solr.analysis
Class SynonymFilter

java.lang.Object
  org.apache.lucene.analysis.TokenStream
      org.apache.lucene.analysis.TokenFilter
          org.apache.solr.analysis.SynonymFilter

public class SynonymFilter
extends org.apache.lucene.analysis.TokenFilter

SynonymFilter handles multi-token synonyms with variable position increment offsets.

The matched tokens from the input stream may be optionally passed through (includeOrig=true) or discarded. If the original tokens are included, the position increments may be modified to retain absolute positions after merging with the synonym tokenstream.

Generated synonyms will start at the same position as the first matched source token.

Version:

$Id: SynonymFilter.java 614793 2008-01-24 04:41:38Z yonik $

Field Summary

Fields inherited from class org.apache.lucene.analysis.TokenFilter

input

Constructor Summary

SynonymFilter(org.apache.lucene.analysis.TokenStream in, SynonymMap map)

Method Summary

org.apache.lucene.analysis.Token

next(org.apache.lucene.analysis.Token target)

Methods inherited from class org.apache.lucene.analysis.TokenFilter

close, reset

Methods inherited from class org.apache.lucene.analysis.TokenStream

next

Methods inherited from class java.lang.Object

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

Constructor Detail

SynonymFilter

public SynonymFilter(org.apache.lucene.analysis.TokenStream in,
                     SynonymMap map)

Method Detail

next

public org.apache.lucene.analysis.Token next(org.apache.lucene.analysis.Token target)
                                      throws IOException

Overrides:

next in class org.apache.lucene.analysis.TokenStream

Throws:

IOException