org.simmetrics.simplifiers

Class DaitchMokotoffSoundex

java.lang.Object

org.simmetrics.simplifiers.DaitchMokotoffSoundex

All Implemented Interfaces:

Simplifier

public class DaitchMokotoffSoundex
extends Object
implements Simplifier

Encodes a string into a Daitch-Mokotoff Soundex value.

The Daitch-Mokotoff Soundex algorithm is a refinement of the Russel and American Soundex algorithms, yielding greater accuracy in matching especially Slavish and Yiddish surnames with similar pronunciation but differences in spelling.

This class is immutable and thread-safe.

See Also:

DaitchMokotoffSoundex, Wikipedia - Daitch-Mokotoff Soundex, Avotaynu - Soundexing and Genealogy

Constructor Summary

Constructors

Constructor and Description
DaitchMokotoffSoundex() Creates a new instance with ASCII-folding enabled.
DaitchMokotoffSoundex(boolean folding) Creates a new DaitchMokotoffSoundex simplifier.

Method Summary

Modifier and Type	Method and Description
String	simplify(String input) Simplifiers the input string.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DaitchMokotoffSoundex

public DaitchMokotoffSoundex()

Creates a new instance with ASCII-folding enabled.

DaitchMokotoffSoundex

public DaitchMokotoffSoundex(boolean folding)

Creates a new DaitchMokotoffSoundex simplifier.

With ASCII-folding enabled, certain accented characters will be transformed to equivalent ASCII characters, e.g. è -> e.

Parameters:

folding - if ASCII-folding shall be performed before encoding

Method Detail

simplify

public String simplify(String input)

Description copied from interface: Simplifier

Simplifiers the input string.

Specified by:

simplify in interface Simplifier

Parameters:

input - string to simplify

Returns:

a simplified string

toString

public String toString()

Overrides:

toString in class Object