org.simmetrics.simplifiers

Class Metaphone

java.lang.Object

org.simmetrics.simplifiers.Metaphone

All Implemented Interfaces:

Simplifier

public class Metaphone
extends Object
implements Simplifier

Encodes a string into a Metaphone value.

All input is converted to upper case. Limitations: Input format is expected to be a single ASCII word with only characters in the A - Z range, no punctuation or numbers.

This class is thread-safe and immutable.

See Also:

Metaphone

Constructor Summary

Constructors

Constructor and Description
Metaphone() Creates an instance of the Metaphone simplifier
Metaphone(int maxCodeLength) Creates an instance of the Metaphone 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

Metaphone

public Metaphone()

Creates an instance of the Metaphone simplifier

Metaphone

public Metaphone(int maxCodeLength)

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

Parameters:

maxCodeLength - maximum length of the 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