org.apache.commons.codec.language

Class SoundexUtils

final class SoundexUtils extends Object

Utility methods for Soundex and RefinedSoundex classes.

Since: 1.3

Version: $Id: SoundexUtils.java 130311 2004-03-17 18:31:35Z ggregory $

Author: Apache Software Foundation

Method Summary
static Stringclean(String str)
Cleans up the input string before Soundex processing by only returning upper case letters.
static intdifference(StringEncoder encoder, String s1, String s2)
Encodes the Strings and returns the number of characters in the two encoded Strings that are the same.
static intdifferenceEncoded(String es1, String es2)
Returns the number of characters in the two Soundex encoded Strings that are the same.

Method Detail

clean

static String clean(String str)
Cleans up the input string before Soundex processing by only returning upper case letters.

Parameters: str The String to clean.

Returns: A clean String.

difference

static int difference(StringEncoder encoder, String s1, String s2)
Encodes the Strings and returns the number of characters in the two encoded Strings that are the same.

Parameters: encoder The encoder to use to encode the Strings. s1 A String that will be encoded and compared. s2 A String that will be encoded and compared.

Returns: The number of characters in the two Soundex encoded Strings that are the same.

Throws: EncoderException if an error occurs encoding one of the strings

See Also: differenceEncoded MS T-SQL DIFFERENCE

differenceEncoded

static int differenceEncoded(String es1, String es2)
Returns the number of characters in the two Soundex encoded Strings that are the same.

Parameters: es1 An encoded String. es2 An encoded String.

Returns: The number of characters in the two Soundex encoded Strings that are the same.

See Also: MS T-SQL DIFFERENCE

commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation