org.apache.commons.codec.language
Class RefinedSoundex
- Encoder, StringEncoder
public class RefinedSoundex
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.
$Id: RefinedSoundex.java,v 1.21 2004/06/05 18:32:04 ggregory Exp $- Apache Software Foundation
static RefinedSoundex | US_ENGLISH - This static variable contains an instance of the RefinedSoundex using
the US_ENGLISH mapping.
|
static char[] | US_ENGLISH_MAPPING - RefinedSoundex is *refined* for a number of reasons one being that the
mappings have been altered.
|
private char[] | soundexMapping - Every letter of the alphabet is "mapped" to a numerical value.
|
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.
|
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.
|
(package private) char | getMappingCode(char c) - Returns the mapping code for a given character.
|
String | soundex(String str) - Retreives the Refined Soundex code for a given String object.
|
US_ENGLISH
public static final RefinedSoundex US_ENGLISH
This static variable contains an instance of the RefinedSoundex using
the US_ENGLISH mapping.
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.
soundexMapping
private char[] soundexMapping
Every letter of the alphabet is "mapped" to a numerical value. This char
array holds the values to which each letter is mapped. This
implementation contains a default map for US_ENGLISH
RefinedSoundex
public RefinedSoundex()
Creates an instance of the RefinedSoundex object using the default US
English mapping.
RefinedSoundex
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.
mapping
- Mapping array to use when finding the corresponding code for
a given character
difference
public int difference(String s1,
String s2)
throws EncoderException
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.
s1
- A String that will be encoded and compared.s2
- A String that will be encoded and compared.
- The number of characters in the two encoded Strings that are the
same from 0 to to the length of the shortest encoded String.
encode
public Object encode(Object pObject)
throws EncoderException
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.
- encode in interface Encoder
pObject
- Object to encode
- An object (or type java.lang.String) containing the refined
soundex code which corresponds to the String supplied.
encode
public String encode(String pString)
Encodes a String using the refined soundex algorithm.
- encode in interface StringEncoder
pString
- A String object to encode
- A Soundex code corresponding to the String supplied
getMappingCode
(package private) char getMappingCode(char c)
Returns the mapping code for a given character. The mapping codes are
maintained in an internal char array named soundexMapping, and the
default values of these mappings are US English.
c
- char to get mapping for
- A character (really a numeral) to return for the given char
soundex
public String soundex(String str)
Retreives the Refined Soundex code for a given String object.
str
- String to encode using the Refined Soundex algorithm
- A soundex code for the String supplied
commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation