com.ptteng.course.util.aliPayUtil.apacheCommonUtil.codec.language

类 Soundex

java.lang.Object

com.ptteng.course.util.aliPayUtil.apacheCommonUtil.codec.language.Soundex

所有已实现的接口:

Encoder, StringEncoder

public class Soundex
extends Object
implements StringEncoder

Encodes a string into a Soundex value. Soundex is an encoding used to relate similar names, but can also be used as a general purpose scheme to find word with similar phonemes. This class is thread-safe. Although not strictly immutable, the maxLength field is not actually used.

版本:

$Id: Soundex.java 1429868 2013-01-07 16:08:05Z ggregory $

字段概要

字段

限定符和类型	字段和说明
static Soundex	US_ENGLISH An instance of Soundex using the US_ENGLISH_MAPPING mapping.
static String	US_ENGLISH_MAPPING_STRING This is a default mapping of the 26 letters used in US English.

构造器概要

构造器

构造器和说明
Soundex() Creates an instance using US_ENGLISH_MAPPING
Soundex(char[] mapping) Creates a soundex instance using the given mapping.
Soundex(String mapping) Creates a refined soundex instance using a custom mapping.

方法概要

限定符和类型	方法和说明
int	difference(String s1, String s2) Encodes the Strings and returns the number of characters in the two encoded Strings that are the same.
Object	encode(Object obj) Encodes an Object using the soundex algorithm.
String	encode(String str) Encodes a String using the soundex algorithm.
int	getMaxLength() 已过时。 This feature is not needed since the encoding size must be constant. Will be removed in 2.0.
void	setMaxLength(int maxLength) 已过时。 This feature is not needed since the encoding size must be constant. Will be removed in 2.0.
String	soundex(String str) Retrieves the Soundex code for a given String object.

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

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

字段详细资料

US_ENGLISH_MAPPING_STRING

public static final String US_ENGLISH_MAPPING_STRING

This is a default mapping of the 26 letters used in US English. A value of 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, 常量字段值

US_ENGLISH

public static final Soundex US_ENGLISH

An instance of Soundex using the US_ENGLISH_MAPPING mapping.

另请参阅:

US_ENGLISH_MAPPING

构造器详细资料

Soundex

public Soundex()

Creates an instance using US_ENGLISH_MAPPING

另请参阅:

Soundex(char[]), US_ENGLISH_MAPPING

Soundex

public Soundex(char[] mapping)

Creates a soundex instance using the given mapping. This constructor can be used to provide an internationalized mapping for a non-Western character set. Every letter of the alphabet is "mapped" to a numerical value. This char array holds the values to which each letter is mapped. This implementation contains a default map for US_ENGLISH

参数:

mapping - Mapping array to use when finding the corresponding code for a given character

Soundex

public Soundex(String mapping)

Creates a refined soundex instance using a custom mapping. This constructor can be used to customize the mapping, and/or possibly provide an internationalized mapping for a non-Western character set.

参数:

mapping - Mapping string to use when finding the corresponding code for a given character

从以下版本开始:

1.4

方法详细资料

difference

public int difference(String s1,
                      String s2)
               throws EncoderException

Encodes the Strings and returns the number of characters in the two encoded Strings that are the same. This return value ranges from 0 through 4: 0 indicates little or no similarity, and 4 indicates strong similarity or identical values.

参数:

s1 - A String that will be encoded and compared.

s2 - A String that will be encoded and compared.

返回:

The number of characters in the two encoded Strings that are the same from 0 to 4.

抛出:

EncoderException - if an error occurs encoding one of the strings

从以下版本开始:

1.3

另请参阅:

SoundexUtils.difference(StringEncoder,String,String), MS T-SQL DIFFERENCE

encode

public Object encode(Object obj)
              throws EncoderException

Encodes an Object using the soundex algorithm. This method is provided in order to satisfy the requirements of the Encoder interface, and will throw an EncoderException if the supplied object is not of type java.lang.String.

指定者:

encode 在接口中 Encoder

参数:

obj - Object to encode

返回:

An object (or type java.lang.String) containing the soundex code which corresponds to the String supplied.

抛出:

EncoderException - if the parameter supplied is not of type java.lang.String

IllegalArgumentException - if a character is not mapped

encode

public String encode(String str)

Encodes a String using the soundex algorithm.

指定者:

encode 在接口中 StringEncoder

参数:

str - A String object to encode

返回:

A Soundex code corresponding to the String supplied

抛出:

IllegalArgumentException - if a character is not mapped

getMaxLength

@Deprecated
public int getMaxLength()

已过时。 This feature is not needed since the encoding size must be constant. Will be removed in 2.0.

Returns the maxLength. Standard Soundex

返回:

int

setMaxLength

@Deprecated
public void setMaxLength(int maxLength)

已过时。 This feature is not needed since the encoding size must be constant. Will be removed in 2.0.

Sets the maxLength.

参数:

maxLength - The maxLength to set

soundex

public String soundex(String str)

Retrieves the Soundex code for a given String object.

参数:

str - String to encode using the Soundex algorithm

返回:

A soundex code for the String supplied

抛出:

IllegalArgumentException - if a character is not mapped