Caverphone2.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      https://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  18. package org.apache.commons.codec.language;

  20. /**
  21.  * Encodes a string into a Caverphone 2.0 value.
  22.  *
  23.  * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0
  24.  * algorithm:
  25.  *
  26.  * @see <a href="https://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
  27.  * @see <a href="https://caversham.otago.ac.nz/files/working/ctp150804.pdf">Caverphone 2.0 specification</a>
  28.  * @since 1.5
  29.  *
  30.  * <p>This class is immutable and thread-safe.</p>
  31.  */
  32. public class Caverphone2 extends AbstractCaverphone {

  34.     private static final String TEN_1 = "1111111111";

  36.     /**
  37.      * Constructs a new instance.
  38.      */
  39.     public Caverphone2() {
  40.         // empty
  41.     }

  43.     /**
  44.      * Encodes the given String into a Caverphone 2.0 value.
  45.      *
  46.      * @param source
  47.      *            String the source string
  48.      * @return A Caverphone code for the given String
  49.      */
  50.     @Override
  51.     public String encode(final String source) {
  52.         String txt = source;
  53.         if (SoundexUtils.isEmpty(txt)) {
  54.             return TEN_1;
  55.         }

  57.         // 1. Convert to lowercase
  58.         txt = txt.toLowerCase(java.util.Locale.ENGLISH);

  60.         // 2. Remove anything not A-Z
  61.         txt = txt.replaceAll("[^a-z]", "");

  63.         // 2.5. Remove final e
  64.         txt = txt.replaceAll("e$", ""); // 2.0 only

  66.         // 3. Handle various start options
  67.         txt = txt.replaceAll("^cough", "cou2f");
  68.         txt = txt.replaceAll("^rough", "rou2f");
  69.         txt = txt.replaceAll("^tough", "tou2f");
  70.         txt = txt.replaceAll("^enough", "enou2f"); // 2.0 only
  71.         txt = txt.replaceAll("^trough", "trou2f"); // 2.0 only
  72.                                                    // note the spec says ^enough here again, c+p error I assume
  73.         txt = txt.replaceAll("^gn", "2n");

  75.         // End
  76.         txt = txt.replaceAll("mb$", "m2");

  78.         // 4. Handle replacements
  79.         txt = txt.replace("cq", "2q");
  80.         txt = txt.replace("ci", "si");
  81.         txt = txt.replace("ce", "se");
  82.         txt = txt.replace("cy", "sy");
  83.         txt = txt.replace("tch", "2ch");
  84.         txt = txt.replace("c", "k");
  85.         txt = txt.replace("q", "k");
  86.         txt = txt.replace("x", "k");
  87.         txt = txt.replace("v", "f");
  88.         txt = txt.replace("dg", "2g");
  89.         txt = txt.replace("tio", "sio");
  90.         txt = txt.replace("tia", "sia");
  91.         txt = txt.replace("d", "t");
  92.         txt = txt.replace("ph", "fh");
  93.         txt = txt.replace("b", "p");
  94.         txt = txt.replace("sh", "s2");
  95.         txt = txt.replace("z", "s");
  96.         txt = txt.replaceAll("^[aeiou]", "A");
  97.         txt = txt.replaceAll("[aeiou]", "3");
  98.         txt = txt.replace("j", "y"); // 2.0 only
  99.         txt = txt.replaceAll("^y3", "Y3"); // 2.0 only
  100.         txt = txt.replaceAll("^y", "A"); // 2.0 only
  101.         txt = txt.replace("y", "3"); // 2.0 only
  102.         txt = txt.replace("3gh3", "3kh3");
  103.         txt = txt.replace("gh", "22");
  104.         txt = txt.replace("g", "k");
  105.         txt = txt.replaceAll("s+", "S");
  106.         txt = txt.replaceAll("t+", "T");
  107.         txt = txt.replaceAll("p+", "P");
  108.         txt = txt.replaceAll("k+", "K");
  109.         txt = txt.replaceAll("f+", "F");
  110.         txt = txt.replaceAll("m+", "M");
  111.         txt = txt.replaceAll("n+", "N");
  112.         txt = txt.replace("w3", "W3");
  113.         txt = txt.replace("wh3", "Wh3");
  114.         txt = txt.replaceAll("w$", "3"); // 2.0 only
  115.         txt = txt.replace("w", "2");
  116.         txt = txt.replaceAll("^h", "A");
  117.         txt = txt.replace("h", "2");
  118.         txt = txt.replace("r3", "R3");
  119.         txt = txt.replaceAll("r$", "3"); // 2.0 only
  120.         txt = txt.replace("r", "2");
  121.         txt = txt.replace("l3", "L3");
  122.         txt = txt.replaceAll("l$", "3"); // 2.0 only
  123.         txt = txt.replace("l", "2");

  125.         // 5. Handle removals
  126.         txt = txt.replace("2", "");
  127.         txt = txt.replaceAll("3$", "A"); // 2.0 only
  128.         txt = txt.replace("3", "");

  130.         // 6. put ten 1s on the end
  131.         txt += TEN_1;

  133.         // 7. take the first ten characters as the code
  134.         return txt.substring(0, TEN_1.length());
  135.     }

  137. }
Created with JaCoCo 0.8.12.202403310830