Class PhoneticEngine

Converts words into potential phonetic representations.

Inheritance
System.Object
PhoneticEngine
Assembly: Lucene.Net.Analysis.Phonetic.dll
Syntax
public class PhoneticEngine : object
Remarks

This is a two-stage process. Firstly, the word is converted into a phonetic representation that takes into account the likely source language. Next, this phonetic representation is converted into a pan-European 'average' representation, allowing comparison between different versions of essentially the same word from different languages.

This class is intentionally immutable and thread-safe. If you wish to alter the settings for a PhoneticEngine, you must make a new one with the updated settings.

Ported from phoneticengine.php

since 1.6

Constructors

Name Description
PhoneticEngine(NameType, RuleType, Boolean)

Generates a new, fully-configured phonetic engine.
PhoneticEngine(NameType, RuleType, Boolean, Int32)

Generates a new, fully-configured phonetic engine.

since 1.7

Properties

Name Description
IsConcat

Gets if multiple phonetic encodings are concatenated or if just the first one is kept. Returns true if multiple phonetic encodings are returned, false if just the first is.
Lang

Gets the Lang language guessing rules being used.
MaxPhonemes

Gets the maximum number of phonemes the engine will calculate for a given input.

since 1.7
NameType

Gets the NameType being used.
RuleType

Gets the RuleType being used.

Methods

Name Description
Encode(String)

Encodes a string to its phonetic representation.
Encode(String, LanguageSet)

Encodes an input string into an output phonetic representation, given a set of possible origin languages.

Extension Methods