org.apache.commons.codec.language

Class SoundexUtils


(package private) final class SoundexUtils
extends Object

Utility methods for Soundex and RefinedSoundex classes.
Version:
$Id: SoundexUtils.java,v 1.5 2004/03/17 18:31:35 ggregory Exp $
Author:
Apache Software Foundation
Since:
1.3

Method Summary

(package private) static String
clean(String str)
Cleans up the input string before Soundex processing by only returning upper case letters.
(package private) 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.
(package private) static int
differenceEncoded(String es1, String es2)
Returns the number of characters in the two Soundex encoded Strings that are the same.

Method Details

clean

(package private) 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

(package private) static int difference(StringEncoder encoder,
                                        String s1,
                                        String s2)
            throws EncoderException
Encodes the Strings and returns the number of characters in the two encoded Strings that are the same.
  • For Soundex, this return value ranges from 0 through 4: 0 indicates little or no similarity, and 4 indicates strong similarity or identical values.
  • For refined Soundex, the return value can be greater than 4.
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

differenceEncoded

(package private) static int differenceEncoded(String es1,
                                               String es2)
Returns the number of characters in the two Soundex encoded Strings that are the same.
  • For Soundex, this return value ranges from 0 through 4: 0 indicates little or no similarity, and 4 indicates strong similarity or identical values.
  • For refined Soundex, the return value can be greater than 4.
Parameters:
es1 - An encoded String.
es2 - An encoded String.
Returns:
The number of characters in the two Soundex encoded Strings that are the same.

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