|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.codec.language.Soundex
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 http://www.bluepoof.com/Soundex/info2.html
Field Summary | |
static Soundex |
US_ENGLISH
|
static char[] |
US_ENGLISH_MAPPING
|
Constructor Summary | |
Soundex()
|
|
Soundex(char[] mapping)
|
Method Summary | |
java.lang.Object |
encode(java.lang.Object pObject)
All encoders allow a library-user to pass an Object and get an Object in return. |
java.lang.String |
encode(java.lang.String pString)
Encode a String and produce a String. |
int |
getMaxLength()
Returns the maxLength. |
void |
setMaxLength(int maxLength)
Sets the maxLength. |
java.lang.String |
soundex(java.lang.String str)
Get the SoundEx value of a string. |
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 Soundex US_ENGLISH
Constructor Detail |
public Soundex()
public Soundex(char[] mapping)
Method Detail |
public java.lang.String soundex(java.lang.String str)
public java.lang.Object encode(java.lang.Object pObject) throws EncoderException
Encoder
encode
in interface Encoder
pObject
- An object ot encode
EncoderException
- an encoder exception is
thrown if the encoder experiences a failure
condition during the encoding process.public java.lang.String encode(java.lang.String pString) throws EncoderException
StringEncoder
encode
in interface StringEncoder
pString
- a String to encode
EncoderException
- thrown if there is
an error conidition during the Encoding process.public int getMaxLength()
public void setMaxLength(int maxLength)
maxLength
- The maxLength to set
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |