public class DoubleMetaphone extends Object implements StringEncoder
Modifier and Type | Class and Description |
---|---|
class |
DoubleMetaphone.DoubleMetaphoneResult
Inner class for storing results, since there is the optional alternate
encoding.
|
Modifier and Type | Field and Description |
---|---|
protected int |
maxCodeLen
Maximum length of an encoding, default is 4
|
Constructor and Description |
---|
DoubleMetaphone()
Creates an instance of this DoubleMetaphone encoder
|
Modifier and Type | Method and Description |
---|---|
protected char |
charAt(String value,
int index)
Gets the character at index
index if available, otherwise
it returns Character.MIN_VALUE so that there is some sort
of a default |
protected static boolean |
contains(String value,
int start,
int length,
String[] criteria)
Determines whether
value contains any of the criteria
starting
at index start and matching up to length length |
String |
doubleMetaphone(String value)
Encode a value with Double Metaphone
|
String |
doubleMetaphone(String value,
boolean alternate)
Encode a value with Double Metaphone, optionally using the alternate
encoding.
|
Object |
encode(Object obj)
Encode the value using DoubleMetaphone.
|
String |
encode(String value)
Encode the value using DoubleMetaphone.
|
int |
getMaxCodeLen()
Returns the maxCodeLen.
|
boolean |
isDoubleMetaphoneEqual(String value1,
String value2)
Check if the Double Metaphone values of two
String values
are equal. |
boolean |
isDoubleMetaphoneEqual(String value1,
String value2,
boolean alternate)
Check if the Double Metaphone values of two
String values
are equal, optionally using the alternate value. |
void |
setMaxCodeLen(int maxCodeLen)
Sets the maxCodeLen.
|
public DoubleMetaphone()
public String doubleMetaphone(String value)
value
- String to encodepublic String doubleMetaphone(String value, boolean alternate)
value
- String to encodealternate
- use alternate encodepublic Object encode(Object obj) throws EncoderException
obj
is a String
(like Metaphone
).encode
in interface Encoder
obj
- Object to encode (should be of type String)EncoderException
- encode parameter is not of type Stringpublic String encode(String value)
encode
in interface StringEncoder
value
- String to encodepublic boolean isDoubleMetaphoneEqual(String value1, String value2)
String
values
are equal.value1
- The left-hand side of the encoded String.equals(Object)
.value2
- The right-hand side of the encoded String.equals(Object)
.true
if the encoded String
s are equal;
false
otherwise.isDoubleMetaphoneEqual(String,String,boolean)
public boolean isDoubleMetaphoneEqual(String value1, String value2, boolean alternate)
String
values
are equal, optionally using the alternate value.value1
- The left-hand side of the encoded String.equals(Object)
.value2
- The right-hand side of the encoded String.equals(Object)
.alternate
- use the alternate value if true
.true
if the encoded String
s are equal;
false
otherwise.public int getMaxCodeLen()
public void setMaxCodeLen(int maxCodeLen)
maxCodeLen
- The maxCodeLen to setprotected char charAt(String value, int index)
index
if available, otherwise
it returns Character.MIN_VALUE
so that there is some sort
of a defaultCopyright © 2016 Internet2. All rights reserved.