Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SolrSynonymParser

    Parser for the Solr synonyms format.

    • Blank lines and lines starting with '#' are comments.
    • Explicit mappings match any token sequence on the LHS of "=>" and replace with all alternatives on the RHS. These types of mappings ignore the expand parameter in the constructor. Example:
      i-pod, i pod => ipod
    • Equivalent synonyms may be separated with commas and give no explicit mapping. In this case the mapping behavior will be taken from the expand parameter in the constructor. This allows the same synonym file to be used in different synonym handling strategies. Example:
      ipod, i-pod, i pod
    • Multiple synonym mapping entries are merged. Example:
      foo => foo bar
              foo => baz
              is equivalent to
              foo => foo bar, baz
    Note

    This API is experimental and might change in incompatible ways in the next release.

    Inheritance
    object
    SynonymMap.Builder
    SynonymMap.Parser
    SolrSynonymParser
    Inherited Members
    SynonymMap.Parser.Analyze(string, CharsRef)
    SynonymMap.Builder.Join(string[], CharsRef)
    SynonymMap.Builder.Add(CharsRef, CharsRef, bool)
    SynonymMap.Builder.Build()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Analysis.Synonym
    Assembly: Lucene.Net.Analysis.Common.dll
    Syntax
    public class SolrSynonymParser : SynonymMap.Parser

    Constructors

    SolrSynonymParser(bool, bool, Analyzer)

    Parser for the Solr synonyms format.

    • Blank lines and lines starting with '#' are comments.
    • Explicit mappings match any token sequence on the LHS of "=>" and replace with all alternatives on the RHS. These types of mappings ignore the expand parameter in the constructor. Example:
      i-pod, i pod => ipod
    • Equivalent synonyms may be separated with commas and give no explicit mapping. In this case the mapping behavior will be taken from the expand parameter in the constructor. This allows the same synonym file to be used in different synonym handling strategies. Example:
      ipod, i-pod, i pod
    • Multiple synonym mapping entries are merged. Example:
      foo => foo bar
              foo => baz
              is equivalent to
              foo => foo bar, baz
    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public SolrSynonymParser(bool dedup, bool expand, Analyzer analyzer)
    Parameters
    Type Name Description
    bool dedup
    bool expand
    Analyzer analyzer

    Methods

    Parse(TextReader)

    Parse the given input, adding synonyms to the inherited SynonymMap.Builder.

    Declaration
    public override void Parse(TextReader @in)
    Parameters
    Type Name Description
    TextReader in

    The input to parse

    Overrides
    SynonymMap.Parser.Parse(TextReader)
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.