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 * http://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 */
17
18 package org.apache.commons.codec.language;
19
20 /**
21 * Encodes a string into a Caverphone 1.0 value.
22 *
23 * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 1.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/ctp060902.pdf">Caverphone 1.0 specification</a>
28 * @since 1.5
29 *
30 * <p>This class is immutable and thread-safe.</p>
31 */
32 public class Caverphone1 extends AbstractCaverphone {
33
34 private static final String SIX_1 = "111111";
35
36 /**
37 * Encodes the given String into a Caverphone value.
38 *
39 * @param source
40 * String the source string
41 * @return A caverphone code for the given String
42 */
43 @Override
44 public String encode(final String source) {
45 String txt = source;
46 if (txt == null || txt.isEmpty()) {
47 return SIX_1;
48 }
49
50 // 1. Convert to lowercase
51 txt = txt.toLowerCase(java.util.Locale.ENGLISH);
52
53 // 2. Remove anything not A-Z
54 txt = txt.replaceAll("[^a-z]", "");
55
56 // 3. Handle various start options
57 // 2 is a temporary placeholder to indicate a consonant which we are no longer interested in.
58 txt = txt.replaceAll("^cough", "cou2f");
59 txt = txt.replaceAll("^rough", "rou2f");
60 txt = txt.replaceAll("^tough", "tou2f");
61 txt = txt.replaceAll("^enough", "enou2f");
62 txt = txt.replaceAll("^gn", "2n");
63
64 // End
65 txt = txt.replaceAll("mb$", "m2");
66
67 // 4. Handle replacements
68 txt = txt.replace("cq", "2q");
69 txt = txt.replace("ci", "si");
70 txt = txt.replace("ce", "se");
71 txt = txt.replace("cy", "sy");
72 txt = txt.replace("tch", "2ch");
73 txt = txt.replace("c", "k");
74 txt = txt.replace("q", "k");
75 txt = txt.replace("x", "k");
76 txt = txt.replace("v", "f");
77 txt = txt.replace("dg", "2g");
78 txt = txt.replace("tio", "sio");
79 txt = txt.replace("tia", "sia");
80 txt = txt.replace("d", "t");
81 txt = txt.replace("ph", "fh");
82 txt = txt.replace("b", "p");
83 txt = txt.replace("sh", "s2");
84 txt = txt.replace("z", "s");
85 txt = txt.replaceAll("^[aeiou]", "A");
86 // 3 is a temporary placeholder marking a vowel
87 txt = txt.replaceAll("[aeiou]", "3");
88 txt = txt.replace("3gh3", "3kh3");
89 txt = txt.replace("gh", "22");
90 txt = txt.replace("g", "k");
91 txt = txt.replaceAll("s+", "S");
92 txt = txt.replaceAll("t+", "T");
93 txt = txt.replaceAll("p+", "P");
94 txt = txt.replaceAll("k+", "K");
95 txt = txt.replaceAll("f+", "F");
96 txt = txt.replaceAll("m+", "M");
97 txt = txt.replaceAll("n+", "N");
98 txt = txt.replace("w3", "W3");
99 txt = txt.replace("wy", "Wy"); // 1.0 only
100 txt = txt.replace("wh3", "Wh3");
101 txt = txt.replace("why", "Why"); // 1.0 only
102 txt = txt.replace("w", "2");
103 txt = txt.replaceAll("^h", "A");
104 txt = txt.replace("h", "2");
105 txt = txt.replace("r3", "R3");
106 txt = txt.replace("ry", "Ry"); // 1.0 only
107 txt = txt.replace("r", "2");
108 txt = txt.replace("l3", "L3");
109 txt = txt.replace("ly", "Ly"); // 1.0 only
110 txt = txt.replace("l", "2");
111 txt = txt.replace("j", "y"); // 1.0 only
112 txt = txt.replace("y3", "Y3"); // 1.0 only
113 txt = txt.replace("y", "2"); // 1.0 only
114
115 // 5. Handle removals
116 txt = txt.replace("2", "");
117 txt = txt.replace("3", "");
118
119 // 6. put six 1s on the end
120 txt += SIX_1;
121
122 // 7. take the first six characters as the code
123 return txt.substring(0, SIX_1.length());
124 }
125
126 }