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
Inherited Members
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

| Improve this Doc View Source

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

| 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
| 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

See Also