Class Metaphone
- All Implemented Interfaces:
- Encoder,- StringEncoder
Initial Java implementation by William B. Brogden. December, 1997. Permission given by wbrogden for code to be used anywhere.
Hanging on the Metaphone by Lawrence Philips in Computer Language of Dec. 1990, p 39.
Note, that this does not match the algorithm that ships with PHP, or the algorithm found in the Perl implementations:
- Text:Metaphone-1.96 (broken link 4/30/2013)
- Text:Metaphone-1.96 (link checked 4/30/2013)
They have had undocumented changes from the originally published algorithm. For more information, see CODEC-57.
 This class is conditionally thread-safe.
 The instance field for maximum code length is mutable setMaxCodeLen(int)
 but is not volatile, and accesses are not synchronized.
 If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronization
 is used to ensure safe publication of the value between threads, and must not invoke setMaxCodeLen(int)
 after initial setup.
 
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionEncodes an Object using the metaphone algorithm.Encodes a String using the Metaphone algorithm.intGets the maxCodeLen.booleanisMetaphoneEqual(String str1, String str2) Tests is the metaphones of two strings are identical.Find the metaphone value of a String.voidsetMaxCodeLen(int maxCodeLen) Sets the maxCodeLen.
- 
Constructor Details- 
Metaphonepublic Metaphone()Constructs a new instance.
 
- 
- 
Method Details- 
encodeEncodes an Object using the metaphone 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 typeString.- Specified by:
- encodein interface- Encoder
- Parameters:
- obj- Object to encode
- Returns:
- An object (or type String) containing the metaphone code which corresponds to the String supplied.
- Throws:
- EncoderException- if the parameter supplied is not of type- String
 
- 
encodeEncodes a String using the Metaphone algorithm.- Specified by:
- encodein interface- StringEncoder
- Parameters:
- str- String object to encode
- Returns:
- The metaphone code corresponding to the String supplied
 
- 
getMaxCodeLenGets the maxCodeLen.- Returns:
- the maxCodeLen.
 
- 
isMetaphoneEqualTests is the metaphones of two strings are identical.- Parameters:
- str1- First of two strings to compare
- str2- Second of two strings to compare
- Returns:
- trueif the metaphones of these strings are identical,- falseotherwise.
 
- 
metaphoneFind the metaphone value of a String. This is similar to the soundex algorithm, but better at finding similar sounding words. All input is converted to upper case. Limitations: Input format is expected to be a single ASCII word with only characters in the A - Z range, no punctuation or numbers.- Parameters:
- txt- String to find the metaphone code for
- Returns:
- A metaphone code corresponding to the String supplied
 
- 
setMaxCodeLenSets the maxCodeLen.- Parameters:
- maxCodeLen- The maxCodeLen to set.
 
 
-