001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.codec.language;
019
020/**
021 * Encodes a string into a Caverphone 1.0 value.
022 *
023 * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 1.0
024 * algorithm:
025 *
026 * @see <a href="https://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
027 * @see <a href="https://caversham.otago.ac.nz/files/working/ctp060902.pdf">Caverphone 1.0 specification</a>
028 * @since 1.5
029 *
030 * <p>This class is immutable and thread-safe.</p>
031 */
032public class Caverphone1 extends AbstractCaverphone {
033
034    private static final String SIX_1 = "111111";
035
036    /**
037     * Constructs a new instance.
038     */
039    public Caverphone1() {
040        // empty
041    }
042
043    /**
044     * Encodes the given String into a Caverphone value.
045     *
046     * @param source
047     *            String the source string
048     * @return A Caverphone code for the given String
049     */
050    @Override
051    public String encode(final String source) {
052        String txt = source;
053        if (txt == null || txt.isEmpty()) {
054            return SIX_1;
055        }
056
057        // 1. Convert to lowercase
058        txt = txt.toLowerCase(java.util.Locale.ENGLISH);
059
060        // 2. Remove anything not A-Z
061        txt = txt.replaceAll("[^a-z]", "");
062
063        // 3. Handle various start options
064        // 2 is a temporary placeholder to indicate a consonant which we are no longer interested in.
065        txt = txt.replaceAll("^cough", "cou2f");
066        txt = txt.replaceAll("^rough", "rou2f");
067        txt = txt.replaceAll("^tough", "tou2f");
068        txt = txt.replaceAll("^enough", "enou2f");
069        txt = txt.replaceAll("^gn", "2n");
070
071        // End
072        txt = txt.replaceAll("mb$", "m2");
073
074        // 4. Handle replacements
075        txt = txt.replace("cq", "2q");
076        txt = txt.replace("ci", "si");
077        txt = txt.replace("ce", "se");
078        txt = txt.replace("cy", "sy");
079        txt = txt.replace("tch", "2ch");
080        txt = txt.replace("c", "k");
081        txt = txt.replace("q", "k");
082        txt = txt.replace("x", "k");
083        txt = txt.replace("v", "f");
084        txt = txt.replace("dg", "2g");
085        txt = txt.replace("tio", "sio");
086        txt = txt.replace("tia", "sia");
087        txt = txt.replace("d", "t");
088        txt = txt.replace("ph", "fh");
089        txt = txt.replace("b", "p");
090        txt = txt.replace("sh", "s2");
091        txt = txt.replace("z", "s");
092        txt = txt.replaceAll("^[aeiou]", "A");
093        // 3 is a temporary placeholder marking a vowel
094        txt = txt.replaceAll("[aeiou]", "3");
095        txt = txt.replace("3gh3", "3kh3");
096        txt = txt.replace("gh", "22");
097        txt = txt.replace("g", "k");
098        txt = txt.replaceAll("s+", "S");
099        txt = txt.replaceAll("t+", "T");
100        txt = txt.replaceAll("p+", "P");
101        txt = txt.replaceAll("k+", "K");
102        txt = txt.replaceAll("f+", "F");
103        txt = txt.replaceAll("m+", "M");
104        txt = txt.replaceAll("n+", "N");
105        txt = txt.replace("w3", "W3");
106        txt = txt.replace("wy", "Wy"); // 1.0 only
107        txt = txt.replace("wh3", "Wh3");
108        txt = txt.replace("why", "Why"); // 1.0 only
109        txt = txt.replace("w", "2");
110        txt = txt.replaceAll("^h", "A");
111        txt = txt.replace("h", "2");
112        txt = txt.replace("r3", "R3");
113        txt = txt.replace("ry", "Ry"); // 1.0 only
114        txt = txt.replace("r", "2");
115        txt = txt.replace("l3", "L3");
116        txt = txt.replace("ly", "Ly"); // 1.0 only
117        txt = txt.replace("l", "2");
118        txt = txt.replace("j", "y"); // 1.0 only
119        txt = txt.replace("y3", "Y3"); // 1.0 only
120        txt = txt.replace("y", "2"); // 1.0 only
121
122        // 5. Handle removals
123        txt = txt.replace("2", "");
124        txt = txt.replace("3", "");
125
126        // 6. put six 1s on the end
127        txt += SIX_1;
128
129        // 7. take the first six characters as the code
130        return txt.substring(0, SIX_1.length());
131    }
132
133}