Class DoubleMetaphone

ES_EP_EB_EL_EY_IB_IL_IN_IE_EI_ER

private static final String[] ES_EP_EB_EL_EY_IB_IL_IN_IE_EI_ER

L_R_N_M_B_H_F_V_W_SPACE

private static final String[] L_R_N_M_B_H_F_V_W_SPACE

L_T_K_S_N_M_B_Z

private static final String[] L_T_K_S_N_M_B_Z

SILENT_START

private static final String[] SILENT_START

Prefixes when present which are not pronounced

VOWELS

private static final String VOWELS

"Vowels" to test for

maxCodeLen

protected int maxCodeLen

Maximum length of an encoding, default is 4

DoubleMetaphone

public DoubleMetaphone()

Creates an instance of this DoubleMetaphone encoder

charAt

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

cleanInput

private String cleanInput(String input)

Cleans the input

conditionC0

private boolean conditionC0(String value,
                            int index)

Complex condition 0 for 'C'

conditionCH0

private boolean conditionCH0(String value,
                             int index)

Complex condition 0 for 'CH'

conditionCH1

private boolean conditionCH1(String value,
                             int index)

Complex condition 1 for 'CH'

conditionL0

private boolean conditionL0(String value,
                            int index)

Complex condition 0 for 'L'

conditionM0

private boolean conditionM0(String value,
                            int index)

Complex condition 0 for 'M'

contains

private static boolean contains(String value,
                                int start,
                                int length,
                                String criteria)

Shortcut method with 1 criteria

contains

private static boolean contains(String value,
                                int start,
                                int length,
                                String criteria1,
                                String criteria2)

Shortcut method with 2 criteria

contains

private static boolean contains(String value,
                                int start,
                                int length,
                                String criteria1,
                                String criteria2,
                                String criteria3)

Shortcut method with 3 criteria

contains

private static boolean contains(String value,
                                int start,
                                int length,
                                String criteria1,
                                String criteria2,
                                String criteria3,
                                String criteria4)

Shortcut method with 4 criteria

contains

private static boolean contains(String value,
                                int start,
                                int length,
                                String criteria1,
                                String criteria2,
                                String criteria3,
                                String criteria4,
                                String criteria5)

Shortcut method with 5 criteria

contains

private static boolean contains(String value,
                                int start,
                                int length,
                                String criteria1,
                                String criteria2,
                                String criteria3,
                                String criteria4,
                                String criteria5,
                                String criteria6)

Shortcut method with 6 criteria

contains

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

doubleMetaphone

public String doubleMetaphone(String value)

Encode a value with Double Metaphone

Parameters:

value - String to encode

Returns:

an encoded string

doubleMetaphone

public String doubleMetaphone(String value,
                              boolean alternate)

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

Parameters:

value - String to encode

alternate - use alternate encode

Returns:

an encoded string

getMaxCodeLen

public int getMaxCodeLen()

Returns the maxCodeLen.

Returns:

int

isDoubleMetaphoneEqual

public 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.

Parameters:

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.

Returns:

true if the encoded Strings are equal; false otherwise.

isSilentStart

private boolean isSilentStart(String value)

Determines whether or not the value starts with a silent letter. It will return true if the value starts with any of 'GN', 'KN', 'PN', 'WR' or 'PS'.

isSlavoGermanic

private boolean isSlavoGermanic(String value)

Determines whether or not a value is of slavo-germanic orgin. A value is of slavo-germanic origin if it contians any of 'W', 'K', 'CZ', or 'WITZ'.

isVowel

private boolean isVowel(char ch)

Determines whether or not a character is a vowel or not

setMaxCodeLen

public void setMaxCodeLen(int maxCodeLen)

Sets the maxCodeLen.

Parameters:

maxCodeLen - The maxCodeLen to set