    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 *      http://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 2.0 value.
    022 *
    023 * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0
    024 * algorithm:
    025 *
    026 * @see <a href="http://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
    027 * @see <a href="http://caversham.otago.ac.nz/files/working/ctp150804.pdf">Caverphone 2.0 specification</a>
    028 * @since 1.5
    029 *
    030 * <p>This class is immutable and thread-safe.</p>
    031 */
    032public class Caverphone2 extends AbstractCaverphone {
    033
    034    private static final String TEN_1 = "1111111111";
    035
    036    /**
    037     * Encodes the given String into a Caverphone 2.0 value.
    038     *
    039     * @param source
    040     *            String the source string
    041     * @return A caverphone code for the given String
    042     */
    043    @Override
    044    public String encode(final String source) {
    045        String txt = source;
    046        if (txt == null || txt.length() == 0) {
    047            return TEN_1;
    048        }
    049
    050        // 1. Convert to lowercase
    051        txt = txt.toLowerCase(java.util.Locale.ENGLISH);
    052
    053        // 2. Remove anything not A-Z
    054        txt = txt.replaceAll("[^a-z]", "");
    055
    056        // 2.5. Remove final e
    057        txt = txt.replaceAll("e$", ""); // 2.0 only
    058
    059        // 3. Handle various start options
    060        txt = txt.replaceAll("^cough", "cou2f");
    061        txt = txt.replaceAll("^rough", "rou2f");
    062        txt = txt.replaceAll("^tough", "tou2f");
    063        txt = txt.replaceAll("^enough", "enou2f"); // 2.0 only
    064        txt = txt.replaceAll("^trough", "trou2f"); // 2.0 only
    065                                                   // note the spec says ^enough here again, c+p error I assume
    066        txt = txt.replaceAll("^gn", "2n");
    067
    068        // End
    069        txt = txt.replaceAll("mb$", "m2");
    070
    071        // 4. Handle replacements
    072        txt = txt.replaceAll("cq", "2q");
    073        txt = txt.replaceAll("ci", "si");
    074        txt = txt.replaceAll("ce", "se");
    075        txt = txt.replaceAll("cy", "sy");
    076        txt = txt.replaceAll("tch", "2ch");
    077        txt = txt.replaceAll("c", "k");
    078        txt = txt.replaceAll("q", "k");
    079        txt = txt.replaceAll("x", "k");
    080        txt = txt.replaceAll("v", "f");
    081        txt = txt.replaceAll("dg", "2g");
    082        txt = txt.replaceAll("tio", "sio");
    083        txt = txt.replaceAll("tia", "sia");
    084        txt = txt.replaceAll("d", "t");
    085        txt = txt.replaceAll("ph", "fh");
    086        txt = txt.replaceAll("b", "p");
    087        txt = txt.replaceAll("sh", "s2");
    088        txt = txt.replaceAll("z", "s");
    089        txt = txt.replaceAll("^[aeiou]", "A");
    090        txt = txt.replaceAll("[aeiou]", "3");
    091        txt = txt.replaceAll("j", "y"); // 2.0 only
    092        txt = txt.replaceAll("^y3", "Y3"); // 2.0 only
    093        txt = txt.replaceAll("^y", "A"); // 2.0 only
    094        txt = txt.replaceAll("y", "3"); // 2.0 only
    095        txt = txt.replaceAll("3gh3", "3kh3");
    096        txt = txt.replaceAll("gh", "22");
    097        txt = txt.replaceAll("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.replaceAll("w3", "W3");
    106        txt = txt.replaceAll("wh3", "Wh3");
    107        txt = txt.replaceAll("w$", "3"); // 2.0 only
    108        txt = txt.replaceAll("w", "2");
    109        txt = txt.replaceAll("^h", "A");
    110        txt = txt.replaceAll("h", "2");
    111        txt = txt.replaceAll("r3", "R3");
    112        txt = txt.replaceAll("r$", "3"); // 2.0 only
    113        txt = txt.replaceAll("r", "2");
    114        txt = txt.replaceAll("l3", "L3");
    115        txt = txt.replaceAll("l$", "3"); // 2.0 only
    116        txt = txt.replaceAll("l", "2");
    117
    118        // 5. Handle removals
    119        txt = txt.replaceAll("2", "");
    120        txt = txt.replaceAll("3$", "A"); // 2.0 only
    121        txt = txt.replaceAll("3", "");
    122
    123        // 6. put ten 1s on the end
    124        txt = txt + TEN_1;
    125
    126        // 7. take the first ten characters as the code
    127        return txt.substring(0, TEN_1.length());
    128    }
    129
    130}