Encoder
, StringEncoder
public class Soundex extends java.lang.Object implements StringEncoder
maxLength
field is not actually used.Modifier and Type | Field | Description |
---|---|---|
private int |
maxLength |
Deprecated.
This feature is not needed since the encoding size must be constant.
|
private char[] |
soundexMapping |
Every letter of the alphabet is "mapped" to a numerical value.
|
static Soundex |
US_ENGLISH |
An instance of Soundex using the US_ENGLISH_MAPPING mapping.
|
private static char[] |
US_ENGLISH_MAPPING |
This is a default mapping of the 26 letters used in US English.
|
static java.lang.String |
US_ENGLISH_MAPPING_STRING |
This is a default mapping of the 26 letters used in US English.
|
Constructor | Description |
---|---|
Soundex() |
Creates an instance using US_ENGLISH_MAPPING
|
Soundex(char[] mapping) |
Creates a soundex instance using the given mapping.
|
Soundex(java.lang.String mapping) |
Creates a refined soundex instance using a custom mapping.
|
Modifier and Type | Method | Description |
---|---|---|
int |
difference(java.lang.String s1,
java.lang.String s2) |
Encodes the Strings and returns the number of characters in the two encoded Strings that are the same.
|
java.lang.Object |
encode(java.lang.Object obj) |
Encodes an Object using the soundex algorithm.
|
java.lang.String |
encode(java.lang.String str) |
Encodes a String using the soundex algorithm.
|
private char |
getMappingCode(java.lang.String str,
int index) |
Used internally by the SoundEx algorithm.
|
int |
getMaxLength() |
Deprecated.
This feature is not needed since the encoding size must be constant.
|
private char[] |
getSoundexMapping() |
Returns the soundex mapping.
|
private char |
map(char ch) |
Maps the given upper-case character to its Soundex code.
|
void |
setMaxLength(int maxLength) |
Deprecated.
This feature is not needed since the encoding size must be constant.
|
java.lang.String |
soundex(java.lang.String str) |
Retrieves the Soundex code for a given String object.
|
public static final java.lang.String US_ENGLISH_MAPPING_STRING
0
for a letter position
means do not encode.
(This constant is provided as both an implementation convenience and to allow Javadoc to pick up the value for the constant values page.)
US_ENGLISH_MAPPING
,
Constant Field Valuesprivate static final char[] US_ENGLISH_MAPPING
0
for a letter position
means do not encode.Soundex(char[])
public static final Soundex US_ENGLISH
US_ENGLISH_MAPPING
@Deprecated private int maxLength
private final char[] soundexMapping
public Soundex()
Soundex(char[])
,
US_ENGLISH_MAPPING
public Soundex(char[] mapping)
mapping
- Mapping array to use when finding the corresponding code for a given characterpublic Soundex(java.lang.String mapping)
mapping
- Mapping string to use when finding the corresponding code for a given characterpublic int difference(java.lang.String s1, java.lang.String s2) throws EncoderException
s1
- A String that will be encoded and compared.s2
- A String that will be encoded and compared.EncoderException
- if an error occurs encoding one of the stringsSoundexUtils.difference(StringEncoder,String,String)
,
MS
T-SQL DIFFERENCE public java.lang.Object encode(java.lang.Object obj) throws EncoderException
encode
in interface Encoder
obj
- Object to encodeEncoderException
- if the parameter supplied is not of type java.lang.Stringjava.lang.IllegalArgumentException
- if a character is not mappedpublic java.lang.String encode(java.lang.String str)
encode
in interface StringEncoder
str
- A String object to encodejava.lang.IllegalArgumentException
- if a character is not mappedprivate char getMappingCode(java.lang.String str, int index)
str
- the cleaned working string to encode (in upper case).index
- the character position to encodejava.lang.IllegalArgumentException
- if the character is not mapped@Deprecated public int getMaxLength()
private char[] getSoundexMapping()
private char map(char ch)
ch
- An upper-case character.java.lang.IllegalArgumentException
- Thrown if ch
is not mapped.@Deprecated public void setMaxLength(int maxLength)
maxLength
- The maxLength to setpublic java.lang.String soundex(java.lang.String str)
str
- String to encode using the Soundex algorithmjava.lang.IllegalArgumentException
- if a character is not mappedcommons-codec version 1.10 - Copyright © 2002-2017 - Apache Software Foundation