Class SynonymFilterFactory

  extended by org.apache.lucene.analysis.util.AbstractAnalysisFactory
      extended by org.apache.lucene.analysis.util.TokenFilterFactory
          extended by org.apache.lucene.analysis.synonym.SynonymFilterFactory
All Implemented Interfaces:

public class SynonymFilterFactory
extends TokenFilterFactory
implements ResourceLoaderAware

Factory for SynonymFilter.

 <fieldType name="text_synonym" class="solr.TextField" positionIncrementGap="100">
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.SynonymFilterFactory" synonyms="synonyms.txt" 
             format="solr" ignoreCase="false" expand="true" 
             [optional tokenizer factory parameters]/>

An optional param name prefix of "tokenizerFactory." may be used for any init params that the SynonymFilterFactory needs to pass to the specified TokenizerFactory. If the TokenizerFactory expects an init parameters with the same name as an init param used by the SynonymFilterFactory, the prefix is mandatory.

The optional format parameter controls how the synonyms will be parsed: It supports the short names of solr for SolrSynonymParser and wordnet for and WordnetSynonymParser, or your own SynonymMap.Parser class name. The default is solr. A custom SynonymMap.Parser is expected to have a constructor taking:

Field Summary
Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
Constructor Summary
SynonymFilterFactory(Map<String,String> args)
Method Summary
 TokenStream create(TokenStream input)
          Transform the specified input TokenStream
 void inform(ResourceLoader loader)
          Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).
Methods inherited from class org.apache.lucene.analysis.util.TokenFilterFactory
availableTokenFilters, forName, lookupClass, reloadTokenFilters
Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
assureMatchVersion, get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitFileNames
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public SynonymFilterFactory(Map<String,String> args)
Method Detail


public TokenStream create(TokenStream input)
Description copied from class: TokenFilterFactory
Transform the specified input TokenStream

Specified by:
create in class TokenFilterFactory


public void inform(ResourceLoader loader)
            throws IOException
Description copied from interface: ResourceLoaderAware
Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).

Specified by:
inform in interface ResourceLoaderAware

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.