Source code
Description: source: package: org.apache.commons.codec.language, class: Caverphone1

    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
    020import java.util.Locale;
    021
    022/**
    023 * Encodes a string into a Caverphone 1.0 value.
    024 *
    025 * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 1.0
    026 * algorithm:
    027 *
    028 * @see <a href="https://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
    029 * @see <a href="https://caversham.otago.ac.nz/files/working/ctp060902.pdf">Caverphone 1.0 specification</a>
    030 * @since 1.5
    031 *
    032 * <p>This class is immutable and thread-safe.</p>
    033 */
    034public class Caverphone1 extends AbstractCaverphone {
    035
    036    private static final String SIX_1 = "111111";
    037
    038    /**
    039     * Constructs a new instance.
    040     */
    041    public Caverphone1() {
    042        // empty
    043    }
    044
    045    /**
    046     * Encodes the given String into a Caverphone value.
    047     *
    048     * @param source
    049     *            String the source string.
    050     * @return A Caverphone code for the given String.
    051     */
    052    @Override
    053    public String encode(final String source) {
    054        String txt = source;
    055        if (txt == null || txt.isEmpty()) {
    056            return SIX_1;
    057        }
    058
    059        // 1. Convert to lowercase
    060        txt = txt.toLowerCase(Locale.ENGLISH);
    061
    062        // 2. Remove anything not A-Z
    063        txt = txt.replaceAll("[^a-z]", "");
    064
    065        // 3. Handle various start options
    066        // 2 is a temporary placeholder to indicate a consonant which we are no longer interested in.
    067        txt = txt.replaceAll("^cough", "cou2f");
    068        txt = txt.replaceAll("^rough", "rou2f");
    069        txt = txt.replaceAll("^tough", "tou2f");
    070        txt = txt.replaceAll("^enough", "enou2f");
    071        txt = txt.replaceAll("^gn", "2n");
    072
    073        // End
    074        txt = txt.replaceAll("mb$", "m2");
    075
    076        // 4. Handle replacements
    077        txt = txt.replace("cq", "2q");
    078        txt = txt.replace("ci", "si");
    079        txt = txt.replace("ce", "se");
    080        txt = txt.replace("cy", "sy");
    081        txt = txt.replace("tch", "2ch");
    082        txt = txt.replace("c", "k");
    083        txt = txt.replace("q", "k");
    084        txt = txt.replace("x", "k");
    085        txt = txt.replace("v", "f");
    086        txt = txt.replace("dg", "2g");
    087        txt = txt.replace("tio", "sio");
    088        txt = txt.replace("tia", "sia");
    089        txt = txt.replace("d", "t");
    090        txt = txt.replace("ph", "fh");
    091        txt = txt.replace("b", "p");
    092        txt = txt.replace("sh", "s2");
    093        txt = txt.replace("z", "s");
    094        txt = txt.replaceAll("^[aeiou]", "A");
    095        // 3 is a temporary placeholder marking a vowel
    096        txt = txt.replaceAll("[aeiou]", "3");
    097        txt = txt.replace("3gh3", "3kh3");
    098        txt = txt.replace("gh", "22");
    099        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
    123
    124        // 5. Handle removals
    125        txt = txt.replace("2", "");
    126        txt = txt.replace("3", "");
    127
    128        // 6. put six 1s on the end
    129        txt += SIX_1;
    130
    131        // 7. take the first six characters as the code
    132        return txt.substring(0, SIX_1.length());
    133    }
    134
    135}