Class RefinedSoundex
java.lang.Object
org.apache.commons.codec.language.RefinedSoundex
- All Implemented Interfaces:
- Encoder,- StringEncoder
Encodes a string into a Refined Soundex value. A refined soundex code is
 optimized for spell checking words. Soundex method originally developed by
 Margaret Odell and Robert Russell.
 
This class is immutable and thread-safe.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final RefinedSoundexThis static variable contains an instance of the RefinedSoundex using the US_ENGLISH mapping.static final StringMapping:
- 
Constructor SummaryConstructorsConstructorDescriptionCreates an instance of the RefinedSoundex object using the default US English mapping.RefinedSoundex(char[] mapping) Creates a refined soundex instance using a custom mapping.RefinedSoundex(String mapping) Creates a refined Soundex instance using a custom mapping.
- 
Method SummaryModifier and TypeMethodDescriptionintdifference(String s1, String s2) Returns the number of characters in the two encoded Strings that are the same.Encodes an Object using the refined soundex algorithm.Encodes a String using the refined soundex algorithm.Retrieves the Refined Soundex code for a given String object.
- 
Field Details- 
US_ENGLISH_MAPPING_STRINGMapping:0: A E I O U Y H W 1: B P 2: F V 3: C K S 4: G J 5: Q X Z 6: D T 7: L 8: M N 9: R - Since:
- 1.4
- See Also:
 
- 
US_ENGLISHThis static variable contains an instance of the RefinedSoundex using the US_ENGLISH mapping.
 
- 
- 
Constructor Details- 
RefinedSoundexpublic RefinedSoundex()Creates an instance of the RefinedSoundex object using the default US English mapping.
- 
RefinedSoundexCreates 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.- Parameters:
- mapping- Mapping array to use when finding the corresponding code for a given character
 
- 
RefinedSoundexCreates 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.- Parameters:
- mapping- Mapping string to use when finding the corresponding code for a given character
- Since:
- 1.4
 
 
- 
- 
Method Details- 
differenceReturns the number of characters in the two encoded Strings that are the same. This return value ranges from 0 to the length of the shortest encoded String: 0 indicates little or no similarity, and 4 out of 4 (for example) indicates strong similarity or identical values. For refined Soundex, the return value can be greater than 4.- Parameters:
- s1- A String that will be encoded and compared.
- s2- A String that will be encoded and compared.
- Returns:
- The number of characters in the two encoded Strings that are the same from 0 to the length of the shortest encoded String.
- Throws:
- EncoderException- if an error occurs encoding one of the strings
- Since:
- 1.3
- See Also:
 
- 
encodeEncodes an Object using the refined 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 typeString.- Specified by:
- encodein interface- Encoder
- Parameters:
- obj- Object to encode
- Returns:
- An object (or type String) containing the refined soundex code which corresponds to the String supplied.
- Throws:
- EncoderException- if the parameter supplied is not of type- String
 
- 
encodeEncodes a String using the refined soundex algorithm.- Specified by:
- encodein interface- StringEncoder
- Parameters:
- str- A String object to encode
- Returns:
- A Soundex code corresponding to the String supplied
 
- 
soundexRetrieves the Refined Soundex code for a given String object.- Parameters:
- str- String to encode using the Refined Soundex algorithm
- Returns:
- A soundex code for the String supplied
 
 
-