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

Lucene.Net.Analysis.Util.AbstractAnalysisFactory

Lucene.Net.Analysis.Util.TokenFilterFactory

PhoneticFilterFactory

Implements

Lucene.Net.Analysis.Util.IResourceLoaderAware

Inherited Members

Lucene.Net.Analysis.Util.TokenFilterFactory.ForName(System.String, System.Collections.Generic.IDictionary<System.String, System.String>)

Lucene.Net.Analysis.Util.TokenFilterFactory.LookupClass(System.String)

Lucene.Net.Analysis.Util.TokenFilterFactory.AvailableTokenFilters

Lucene.Net.Analysis.Util.TokenFilterFactory.ReloadTokenFilters()

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.LUCENE_MATCH_VERSION_PARAM

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.m_luceneMatchVersion

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.OriginalArgs

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.AssureMatchVersion()

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.LuceneMatchVersion

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Require(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Require(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Require(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>, System.Boolean)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Get(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Get(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Get(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.Get(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Collections.Generic.ICollection<System.String>, System.String, System.Boolean)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.RequireInt32(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetInt32(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Int32)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.RequireBoolean(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetBoolean(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Boolean)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.RequireSingle(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetSingle(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Single)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.RequireChar(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetChar(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Char)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetSet(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetPattern(System.Collections.Generic.IDictionary<System.String, System.String>, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetCulture(System.Collections.Generic.IDictionary<System.String, System.String>, System.String, System.Globalization.CultureInfo)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetWordSet(Lucene.Net.Analysis.Util.IResourceLoader, System.String, System.Boolean)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetLines(Lucene.Net.Analysis.Util.IResourceLoader, System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetSnowballWordSet(Lucene.Net.Analysis.Util.IResourceLoader, System.String, System.Boolean)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.SplitFileNames(System.String)

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.GetClassArg()

Lucene.Net.Analysis.Util.AbstractAnalysisFactory.IsExplicitLuceneMatchVersion

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lucene.Net.Analysis.Phonetic

Assembly: Lucene.Net.Analysis.Phonetic.dll

Syntax

public class PhoneticFilterFactory : TokenFilterFactory, IResourceLoaderAware

Constructors

PhoneticFilterFactory(IDictionary<String, String>)

Creates a new PhoneticFilterFactory.

Declaration

public PhoneticFilterFactory(IDictionary<string, string> args)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.String>	args

Fields

ENCODER

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

Declaration

public const string ENCODER = "encoder"

Field Value

Type	Description
System.String

INJECT

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

Declaration

public const string INJECT = "inject"

Field Value

Type	Description
System.String

MAX_CODE_LENGTH

Declaration

public const string MAX_CODE_LENGTH = "maxCodeLength"

Field Value

Type	Description
System.String

Methods

Create(TokenStream)

Declaration

public override TokenStream Create(TokenStream input)

Parameters

Type	Name	Description
Lucene.Net.Analysis.TokenStream	input

Returns

Type	Description
Lucene.Net.Analysis.TokenStream

Overrides

Lucene.Net.Analysis.Util.TokenFilterFactory.Create(Lucene.Net.Analysis.TokenStream)

GetEncoder()

Must be thread-safe.

Declaration

protected virtual IStringEncoder GetEncoder()

Returns

Type	Description
IStringEncoder

Inform(IResourceLoader)

Declaration

public virtual void Inform(IResourceLoader loader)

Parameters

Type	Name	Description
Lucene.Net.Analysis.Util.IResourceLoader	loader

Implements

Lucene.Net.Analysis.Util.IResourceLoaderAware

See Also

PhoneticFilter