Class AbstractCaverphone

Encodes a string into a Caverphone value.

This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0 algorithm:

This class is immutable and thread-safe.

See Wikipedia - Caverphone

Inheritance

object

AbstractCaverphone

Caverphone1

Caverphone2

Implements

IStringEncoder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Analysis.Phonetic.Language

Assembly: Lucene.Net.Analysis.Phonetic.dll

Syntax

public abstract class AbstractCaverphone : IStringEncoder

Constructors

AbstractCaverphone()

Creates an instance of the Caverphone encoder

Declaration

protected AbstractCaverphone()

Methods

Encode(string)

Encodes a string and returns a string.

Declaration

public abstract string Encode(string source)

Parameters

Type	Name	Description
string	source	the string to encode

Returns

Type	Description
string	the encoded string

IsEncodeEqual(string, string)

Tests if the encodings of two strings are equal.

This method might be promoted to a new AbstractStringEncoder superclass.

Declaration

public virtual bool IsEncodeEqual(string str1, string str2)

Parameters

Type	Name	Description
string	str1	First of two strings to compare.
string	str2	Second of two strings to compare.

Returns

Type	Description
bool	true if the encodings of these strings are identical, false otherwise.

Implements

IStringEncoder