Caverphone1.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. import java.util.Locale;

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

  36.     private static final String SIX_1 = "111111";

  38.     /**
  39.      * Constructs a new instance.
  40.      */
  41.     public Caverphone1() {
  42.         // empty
  43.     }

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

  59.         // 1. Convert to lowercase
  60.         txt = txt.toLowerCase(Locale.ENGLISH);

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

  65.         // 3. Handle various start options
  66.         // 2 is a temporary placeholder to indicate a consonant which we are no longer interested in.
  67.         txt = txt.replaceAll("^cough", "cou2f");
  68.         txt = txt.replaceAll("^rough", "rou2f");
  69.         txt = txt.replaceAll("^tough", "tou2f");
  70.         txt = txt.replaceAll("^enough", "enou2f");
  71.         txt = txt.replaceAll("^gn", "2n");

  73.         // End
  74.         txt = txt.replaceAll("mb$", "m2");

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

  124.         // 5. Handle removals
  125.         txt = txt.replace("2", "");
  126.         txt = txt.replace("3", "");

  128.         // 6. put six 1s on the end
  129.         txt += SIX_1;

  131.         // 7. take the first six characters as the code
  132.         return txt.substring(0, SIX_1.length());
  133.     }

  135. }
Created with JaCoCo 0.8.13.202504020838