org.simmetrics.simplifiers

Class Nysiis

java.lang.Object

org.simmetrics.simplifiers.Nysiis

All Implemented Interfaces:

Simplifier

public class Nysiis
extends Object
implements Simplifier

Encodes a string into a NYSIIS value. NYSIIS is an encoding used to relate similar names, but can also be used as a general purpose scheme to find word with similar phonemes. This class is thread-safe and immutable.

See Also:

Nysiis

Constructor Summary

Constructors

Constructor and Description
Nysiis() Creates an instance of the Nysiis encoder with strict mode (original form), i.e.
Nysiis(boolean strict) Create an instance of the Nysiis simplifier with the specified strict mode: true: encoded strings have a maximum length of 6 false: encoded strings may have arbitrary length

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

Nysiis

public Nysiis()

Creates an instance of the Nysiis encoder with strict mode (original form), i.e. encoded strings have a maximum length of 6.

Nysiis

public Nysiis(boolean strict)

Create an instance of the Nysiis simplifier with the specified strict mode:

• true: encoded strings have a maximum length of 6
• false: encoded strings may have arbitrary length

Parameters:

strict - the strict mode

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