[CODEC-125] Implement a Beider-Morse phonetic matching codec. Applied patch https://issues.apache.org/jira/secure/attachment/12489767/comparator.patch

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1155182 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

src/java/org/apache/commons/codec/language/bm/PhoneticEngine.java

@@ -251,7 +251,7 @@ private PhonemeBuilder applyFinalRules(PhonemeBuilder phonemeBuilder, List<Rule>
             return phonemeBuilder;
         }
 
-        Set<Rule.Phoneme> phonemes = new TreeSet<Rule.Phoneme>();
+        Set<Rule.Phoneme> phonemes = new TreeSet<Rule.Phoneme>(Rule.Phoneme.COMPARATOR);
 
         for (Rule.Phoneme phoneme : phonemeBuilder.getPhonemes()) {
             PhonemeBuilder subBuilder = PhonemeBuilder.empty(phoneme.getLanguages());

src/java/org/apache/commons/codec/language/bm/Rule.java

@@ -21,6 +21,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.Comparator;
 import java.util.EnumMap;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -80,7 +81,26 @@
  */
 public class Rule {
 
-    public static final class Phoneme implements PhonemeExpr, Comparable<Phoneme> {
+    public static final class Phoneme implements PhonemeExpr {
+        public static final Comparator<Phoneme> COMPARATOR = new Comparator<Phoneme>() {
+            public int compare(Phoneme o1, Phoneme o2) {
+                for (int i = 0; i < o1.phonemeText.length(); i++) {
+                    if (i >= o2.phonemeText.length()) {
+                        return +1;
+                    }
+                    int c = o1.phonemeText.charAt(i) - o2.phonemeText.charAt(i);
+                    if (c != 0) {
+                        return c;
+                    }
+                }
+
+                if (o1.phonemeText.length() < o2.phonemeText.length()) {
+                    return -1;
+                }
+
+                return 0;
+            }
+        };
 
         private final CharSequence phonemeText;
         private final Languages.LanguageSet languages;
@@ -94,24 +114,6 @@ public Phoneme append(CharSequence str) {
             return new Phoneme(this.phonemeText.toString() + str.toString(), this.languages);
         }
 
-        public int compareTo(Phoneme o) {
-            for (int i = 0; i < phonemeText.length(); i++) {
-                if (i >= o.phonemeText.length()) {
-                    return +1;
-                }
-                int c = phonemeText.charAt(i) - o.phonemeText.charAt(i);
-                if (c != 0) {
-                    return c;
-                }
-            }
-
-            if (phonemeText.length() < o.phonemeText.length()) {
-                return -1;
-            }
-
-            return 0;
-        }
-
         public Languages.LanguageSet getLanguages() {
             return this.languages;
         }

src/test/org/apache/commons/codec/language/bm/RuleTest.java

@@ -63,7 +63,7 @@ public void phonemeComparedToLaterIsNegative() {
         for (Rule.Phoneme[] phs : makePhonemes()) {
             for (int i = 0; i < phs.length; i++) {
                 for (int j = i + 1; j < phs.length; j++) {
-                    int c = phs[i].compareTo(phs[j]);
+                    int c = Rule.Phoneme.COMPARATOR.compare(phs[i], phs[j]);
 
                     assertThat("Comparing " + phs[i].getPhonemeText() + " to " + phs[j].getPhonemeText() + " should be negative", c,
                             new NegativeIntegerBaseMatcher());
@@ -76,7 +76,8 @@ public void phonemeComparedToLaterIsNegative() {
     public void phonemeComparedToSelfIsZero() {
         for (Rule.Phoneme[] phs : makePhonemes()) {
             for (Rule.Phoneme ph : phs) {
-                assertEquals("Phoneme compared to itself should be zero: " + ph.getPhonemeText(), 0, ph.compareTo(ph));
+                assertEquals("Phoneme compared to itself should be zero: " + ph.getPhonemeText(), 0,
+                        Rule.Phoneme.COMPARATOR.compare(ph, ph));
             }
         }
     }