|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.sun.mdm.index.phonetic.impl.Soundex
Encode a string using the Soundex algorithm.
| Field Summary | |
static java.lang.String |
ENCODING_TYPE
Informative String about the encoding type this encoder does |
static char[] |
US_ENGLISH_MAPPING
The default soundex mapping used |
| Constructor Summary | |
Soundex()
Creates a new Soundex encoder |
|
Soundex(char[] mapping)
Creates a new Soundex encoder using a given soundex mapping |
|
| Method Summary | |
java.lang.String |
encode(java.lang.String value)
Encode the value using Soundex. |
java.lang.String |
encode(java.lang.String str,
java.lang.String domain)
Encode a string phoneticaly with SoundEx. |
java.lang.String |
getEncodingType()
Getter for the encoding type attribute |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final java.lang.String ENCODING_TYPE
public static final char[] US_ENGLISH_MAPPING
| Constructor Detail |
public Soundex()
public Soundex(char[] mapping)
mapping - the soundex mapping to use| Method Detail |
public java.lang.String encode(java.lang.String value)
throws PhoneticEncoderException
encode in interface PhoneticEncodervalue - String to encode
PhoneticEncoderException - thrown if there is an exception during
the encoding process.
public java.lang.String encode(java.lang.String str,
java.lang.String domain)
throws PhoneticEncoderException
encode in interface PhoneticEncoderstr - The string to encodedomain - A domain marking the country/language context. An optional feature
for an encoder to implement.
This encoder does not currently support domains.
PhoneticEncoderException - if the encoding fails.public java.lang.String getEncodingType()
getEncodingType in interface PhoneticEncoder
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Sun Microsystems, Inc.