Class SynonymFilterFactory

Factory for SynonymFilter.

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

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:

  • bool dedup - true if duplicates should be ignored, false otherwise
  • bool expand - true if conflation groups should be expanded, false if they are one-directional
  • Lucene.Net.Analysis.Analyzer analyzer - an analyzer used for each raw synonym
Inheritance
object
AbstractAnalysisFactory
TokenFilterFactory
SynonymFilterFactory
Inherited Members
Namespace: Lucene.Net.Analysis.Synonym
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public class SynonymFilterFactory : TokenFilterFactory, IResourceLoaderAware

Constructors

SynonymFilterFactory(IDictionary<string, string>)

Factory for SynonymFilter.

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

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:

  • bool dedup - true if duplicates should be ignored, false otherwise
  • bool expand - true if conflation groups should be expanded, false if they are one-directional
  • Lucene.Net.Analysis.Analyzer analyzer - an analyzer used for each raw synonym
Declaration
public SynonymFilterFactory(IDictionary<string, string> args)
Parameters
Type Name Description
IDictionary<string, string> args

Methods

Create(TokenStream)

Transform the specified input Lucene.Net.Analysis.TokenStream

Declaration
public override TokenStream Create(TokenStream input)
Parameters
Type Name Description
TokenStream input
Returns
Type Description
TokenStream
Overrides

Inform(IResourceLoader)

Initializes this component with the provided IResourceLoader (used for loading types, embedded resources, files, etc).

Declaration
public virtual void Inform(IResourceLoader loader)
Parameters
Type Name Description
IResourceLoader loader

Implements