org.simmetrics.simplifiers

Class DoubleMetaphone

java.lang.Object

org.simmetrics.simplifiers.DoubleMetaphone

All Implemented Interfaces:

Simplifier

public class DoubleMetaphone
extends Object
implements Simplifier

Encodes a string into a double metaphone value. This Implementation is based on the algorithm by Lawrence Philips. This class is immutable and thread-safe.

See Also:

DoubleMetaphone

Constructor Summary

Constructors

Constructor and Description
DoubleMetaphone() Creates an instance of this DoubleMetaphone encoder
DoubleMetaphone(int maxCodeLength, boolean useAlternate) Creates an instance of the DoubleMetaphone simplifier with a maxCodeLength.

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

DoubleMetaphone

public DoubleMetaphone()

Creates an instance of this DoubleMetaphone encoder

DoubleMetaphone

public DoubleMetaphone(int maxCodeLength,
                       boolean useAlternate)

Creates an instance of the DoubleMetaphone simplifier with a maxCodeLength. All encodings will have at most maxCodeLength characters.

Parameters:

maxCodeLength - the maximum length of the code

useAlternate - use alternate encode

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