Show / Hide Table of Contents

    Class PhoneticFilterFactory

    Factory for PhoneticFilter.

    Create tokens based on phonetic encoders from the Language namespace.

    This takes one required argument, "encoder", and the rest are optional:

    • encoder required, one of "DoubleMetaphone", "Metaphone", "Soundex", "RefinedSoundex", "Caverphone" (v2.0), or "ColognePhonetic" (case insensitive). If encoder isn't one of these, it'll be resolved as a class name either by itself if it already contains a '.' or otherwise as in the same package as these others.
    • inject (default=true) add tokens to the stream with the offset=0
    • maxCodeLength The maximum length of the phonetic codes, as defined by the encoder. If an encoder doesn't support this then specifying this is an error.

    <fieldType name="text_phonetic" class="solr.TextField" positionIncrementGap="100">
      <analyzer>
        <tokenizer class="solr.WhitespaceTokenizerFactory"/>
        <filter class="solr.PhoneticFilterFactory" encoder="DoubleMetaphone" inject="true"/>
      </analyzer>
    </fieldType>
    Inheritance
    System.Object
    AbstractAnalysisFactory
    TokenFilterFactory
    PhoneticFilterFactory
    Implements
    IResourceLoaderAware
    Inherited Members
    TokenFilterFactory.ForName(String, IDictionary<String, String>)
    TokenFilterFactory.LookupClass(String)
    TokenFilterFactory.AvailableTokenFilters
    TokenFilterFactory.ReloadTokenFilters()
    AbstractAnalysisFactory.LUCENE_MATCH_VERSION_PARAM
    AbstractAnalysisFactory.m_luceneMatchVersion
    AbstractAnalysisFactory.OriginalArgs
    AbstractAnalysisFactory.AssureMatchVersion()
    AbstractAnalysisFactory.LuceneMatchVersion
    AbstractAnalysisFactory.Require(IDictionary<String, String>, String)
    AbstractAnalysisFactory.Require(IDictionary<String, String>, String, ICollection<String>)
    AbstractAnalysisFactory.Require(IDictionary<String, String>, String, ICollection<String>, Boolean)
    AbstractAnalysisFactory.Get(IDictionary<String, String>, String, String)
    AbstractAnalysisFactory.Get(IDictionary<String, String>, String, ICollection<String>)
    AbstractAnalysisFactory.Get(IDictionary<String, String>, String, ICollection<String>, String)
    AbstractAnalysisFactory.Get(IDictionary<String, String>, String, ICollection<String>, String, Boolean)
    AbstractAnalysisFactory.RequireInt32(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetInt32(IDictionary<String, String>, String, Int32)
    AbstractAnalysisFactory.RequireBoolean(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetBoolean(IDictionary<String, String>, String, Boolean)
    AbstractAnalysisFactory.RequireSingle(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetSingle(IDictionary<String, String>, String, Single)
    AbstractAnalysisFactory.RequireChar(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetChar(IDictionary<String, String>, String, Char)
    AbstractAnalysisFactory.GetSet(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetPattern(IDictionary<String, String>, String)
    AbstractAnalysisFactory.GetCulture(IDictionary<String, String>, String, CultureInfo)
    AbstractAnalysisFactory.GetWordSet(IResourceLoader, String, Boolean)
    AbstractAnalysisFactory.GetLines(IResourceLoader, String)
    AbstractAnalysisFactory.GetSnowballWordSet(IResourceLoader, String, Boolean)
    AbstractAnalysisFactory.SplitFileNames(String)
    AbstractAnalysisFactory.GetClassArg()
    AbstractAnalysisFactory.IsExplicitLuceneMatchVersion
    Namespace: Lucene.Net.Analysis.Phonetic
    Assembly: Lucene.Net.Analysis.Phonetic.dll
    Syntax
    public class PhoneticFilterFactory : TokenFilterFactory, IResourceLoaderAware

    Constructors

    | Improve this Doc View Source

    PhoneticFilterFactory(IDictionary<String, String>)

    Creates a new PhoneticFilterFactory.

    Declaration
    public PhoneticFilterFactory(IDictionary<string, string> args)
    Parameters
    Type Name Description
    IDictionary<System.String, System.String> args

    Fields

    | Improve this Doc View Source

    ENCODER

    parameter name: either a short name or a full class name

    Declaration
    public static readonly string ENCODER
    Field Value
    Type Description
    System.String
    | Improve this Doc View Source

    INJECT

    parameter name: true if encoded tokens should be added as synonyms

    Declaration
    public static readonly string INJECT
    Field Value
    Type Description
    System.String
    | Improve this Doc View Source

    MAX_CODE_LENGTH

    Declaration
    public static readonly string MAX_CODE_LENGTH
    Field Value
    Type Description
    System.String

    Methods

    | Improve this Doc View Source

    Create(TokenStream)

    Declaration
    public override TokenStream Create(TokenStream input)
    Parameters
    Type Name Description
    TokenStream input
    Returns
    Type Description
    TokenStream
    Overrides
    TokenFilterFactory.Create(TokenStream)
    | Improve this Doc View Source

    GetEncoder()

    Must be thread-safe.

    Declaration
    protected virtual IStringEncoder GetEncoder()
    Returns
    Type Description
    IStringEncoder
    | Improve this Doc View Source

    Inform(IResourceLoader)

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

    Implements

    IResourceLoaderAware

    See Also

    PhoneticFilter
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)