depends.org.apache.commons.codec.language

类 DoubleMetaphone

java.lang.Object

depends.org.apache.commons.codec.language.DoubleMetaphone

所有已实现的接口:

Encoder, StringEncoder

public class DoubleMetaphone
extends java.lang.Object
implements StringEncoder

Encodes a string into a double metaphone value. This Implementation is based on the algorithm by Lawrence Philips.

• Original Article: http://www.cuj.com/documents/s=8038/cuj0006philips/
• Original Source Code: ftp://ftp.cuj.com/pub/2000/1806/philips.zip

嵌套类概要

嵌套类

限定符和类型	类和说明
class	DoubleMetaphone.DoubleMetaphoneResult Inner class for storing results, since there is the optional alternate encoding.

构造器概要

构造器

构造器和说明
DoubleMetaphone() Creates an instance of this DoubleMetaphone encoder

方法概要

方法

限定符和类型	方法和说明
protected char	charAt(java.lang.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(java.lang.String value, int start, int length, java.lang.String[] criteria) Determines whether value contains any of the criteria starting at index start and matching up to length length
java.lang.String	doubleMetaphone(java.lang.String value) Encode a value with Double Metaphone
java.lang.String	doubleMetaphone(java.lang.String value, boolean alternate) Encode a value with Double Metaphone, optionally using the alternate encoding.
java.lang.Object	encode(java.lang.Object obj) Encode the value using DoubleMetaphone.
java.lang.String	encode(java.lang.String value) Encode the value using DoubleMetaphone.
int	getMaxCodeLen() Returns the maxCodeLen.
boolean	isDoubleMetaphoneEqual(java.lang.String value1, java.lang.String value2) Check if the Double Metaphone values of two String values are equal.
boolean	isDoubleMetaphoneEqual(java.lang.String value1, java.lang.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.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

DoubleMetaphone

public DoubleMetaphone()

Creates an instance of this DoubleMetaphone encoder

方法详细资料

doubleMetaphone

public java.lang.String doubleMetaphone(java.lang.String value)

Encode a value with Double Metaphone

参数:

value - String to encode

返回:

an encoded string

doubleMetaphone

public java.lang.String doubleMetaphone(java.lang.String value,
                               boolean alternate)

Encode a value with Double Metaphone, optionally using the alternate encoding.

参数:

value - String to encode

alternate - use alternate encode

返回:

an encoded string

encode

public java.lang.Object encode(java.lang.Object obj)
                        throws EncoderException

Encode the value using DoubleMetaphone. It will only work if obj is a String (like Metaphone).

指定者:

encode 在接口中 Encoder

参数:

obj - Object to encode (should be of category String)

返回:

An encoded Object (will be of category String)

抛出:

EncoderException - encode parameter is not of category String

encode

public java.lang.String encode(java.lang.String value)

Encode the value using DoubleMetaphone.

指定者:

encode 在接口中 StringEncoder

参数:

value - String to encode

返回:

An encoded String

isDoubleMetaphoneEqual

public boolean isDoubleMetaphoneEqual(java.lang.String value1,
                             java.lang.String value2)

Check if the Double Metaphone values of two 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 Strings are equal; false otherwise.

另请参阅:

isDoubleMetaphoneEqual(String,String,boolean)

isDoubleMetaphoneEqual

public boolean isDoubleMetaphoneEqual(java.lang.String value1,
                             java.lang.String value2,
                             boolean alternate)

Check if the Double Metaphone values of two 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 Strings are equal; false otherwise.

getMaxCodeLen

public int getMaxCodeLen()

Returns the maxCodeLen.

返回:

int

setMaxCodeLen

public void setMaxCodeLen(int maxCodeLen)

Sets the maxCodeLen.

参数:

maxCodeLen - The maxCodeLen to set

charAt

protected char charAt(java.lang.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

contains

protected static boolean contains(java.lang.String value,
               int start,
               int length,
               java.lang.String[] criteria)

Determines whether value contains any of the criteria starting at index start and matching up to length length