public class

RefinedSoundex

extends Object
implements StringEncoder
java.lang.Object
   ↳ org.apache.commons.codec.language.RefinedSoundex

Class Overview

Encodes a string into a Refined Soundex value. A refined soundex code is optimized for spell checking words. Soundex method originally developed by Margaret Odell and Robert Russell.

Summary

Constants
String US_ENGLISH_MAPPING_STRING
Fields
public static final RefinedSoundex US_ENGLISH This static variable contains an instance of the RefinedSoundex using the US_ENGLISH mapping.
public static final char[] US_ENGLISH_MAPPING RefinedSoundex is *refined* for a number of reasons one being that the mappings have been altered.
Public Constructors
RefinedSoundex()
Creates an instance of the RefinedSoundex object using the default US English mapping.
RefinedSoundex(char[] mapping)
Creates a refined soundex instance using a custom mapping.
RefinedSoundex(String mapping)
Creates a refined Soundex instance using a custom mapping.
Public Methods
int difference(String s1, String s2)
Returns the number of characters in the two encoded Strings that are the same.
Object encode(Object pObject)
Encodes an Object using the refined soundex algorithm.
String encode(String pString)
Encodes a String using the refined soundex algorithm.
String soundex(String str)
Retreives the Refined Soundex code for a given String object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.commons.codec.Encoder
From interface org.apache.commons.codec.StringEncoder

Constants

public static final String US_ENGLISH_MAPPING_STRING

Constant Value: "01360240043788015936020505"

Fields

public static final RefinedSoundex US_ENGLISH

This static variable contains an instance of the RefinedSoundex using the US_ENGLISH mapping.

public static final char[] US_ENGLISH_MAPPING

RefinedSoundex is *refined* for a number of reasons one being that the mappings have been altered. This implementation contains default mappings for US English.

Public Constructors

public RefinedSoundex ()

Creates an instance of the RefinedSoundex object using the default US English mapping.

public RefinedSoundex (char[] mapping)

Creates a refined soundex instance using a custom mapping. This constructor can be used to customize the mapping, and/or possibly provide an internationalized mapping for a non-Western character set.

Parameters
mapping Mapping array to use when finding the corresponding code for a given character

public RefinedSoundex (String mapping)

Creates a refined Soundex instance using a custom mapping. This constructor can be used to customize the mapping, and/or possibly provide an internationalized mapping for a non-Western character set.

Parameters
mapping Mapping string to use when finding the corresponding code for a given character

Public Methods

public int difference (String s1, String s2)

Returns the number of characters in the two encoded Strings that are the same. This return value ranges from 0 to the length of the shortest encoded String: 0 indicates little or no similarity, and 4 out of 4 (for example) indicates strong similarity or identical values. For refined Soundex, the return value can be greater than 4.

Parameters
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 encoded Strings that are the same from 0 to to the length of the shortest encoded String.
Throws
EncoderException if an error occurs encoding one of the strings
See Also

public Object encode (Object pObject)

Encodes an Object using the refined soundex algorithm. This method is provided in order to satisfy the requirements of the Encoder interface, and will throw an EncoderException if the supplied object is not of type java.lang.String.

Parameters
pObject Object to encode
Returns
  • An object (or type java.lang.String) containing the refined soundex code which corresponds to the String supplied.
Throws
EncoderException if the parameter supplied is not of type java.lang.String

public String encode (String pString)

Encodes a String using the refined soundex algorithm.

Parameters
pString A String object to encode
Returns
  • A Soundex code corresponding to the String supplied

public String soundex (String str)

Retreives the Refined Soundex code for a given String object.

Parameters
str String to encode using the Refined Soundex algorithm
Returns
  • A soundex code for the String supplied