|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.codec.language.RefinedSoundex
Encodes a string into a refined soundex value. A refined soundex code is optimized for spell checking word. "Soundex" method originally developed by Margaret Odell and Robert Russell
Field Summary | |
private char[] |
soundexMapping
Every letter of the alphabet is "mapped" to a numerical value. |
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. |
Constructor Summary | |
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. |
Method Summary | |
Object |
encode(Object pObject)
Encodes an Object using the refined soundex algorithm. |
String |
encode(String pString)
Encodes a String using the refined soundex algorithm. |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final char[] US_ENGLISH_MAPPING
public static final RefinedSoundex US_ENGLISH
private char[] soundexMapping
Constructor Detail |
public RefinedSoundex()
public RefinedSoundex(char[] mapping)
mapping
- Mapping array to use when finding the corresponding
code for a given characterMethod Detail |
public String soundex(String str)
str
- String to encode using the Refined Soundex algorithm
public String encode(String pString)
encode
in interface StringEncoder
pString
- A String object to encode
EncoderException
- throws exception if there is an
encoding-specific problempublic Object encode(Object pObject) throws EncoderException
encode
in interface Encoder
pObject
- Object to encode
EncoderException
- if the parameter supplied is not
of type java.lang.Stringprivate char getMappingCode(char c)
c
- char to get mapping for
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |