org.simmetrics.simplifiers.Nysiis Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simmetrics-core Show documentation

There is a newer version: 4.1.1

package org.simmetrics.simplifiers;

/**
 * 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 org.apache.commons.codec.language.Nysiis
 */
public class Nysiis implements Simplifier {

	private final org.apache.commons.codec.language.Nysiis simplifier;

	/**
	 * Creates an instance of the Nysiis encoder with strict mode (original
	 * form), i.e. encoded strings have a maximum length of 6.
	 */
	public Nysiis() {
		this(true);
	}

	/**
	 * 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
	 * 
	 *
	 * @param strict
	 *            the strict mode
	 */
	public Nysiis(boolean strict) {
		this.simplifier = new org.apache.commons.codec.language.Nysiis(strict);
	}

	@Override
	public String simplify(String input) {
		return simplifier.nysiis(input);
	}

	@Override
	public String toString() {
		return "Nysiis";
	}

}