1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 package org.apache.commons.codec.language;
19
20 import java.util.regex.Pattern;
21
22 import org.apache.commons.codec.EncoderException;
23 import org.apache.commons.codec.StringEncoder;
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72 public class Nysiis implements StringEncoder {
73
74 private static final char[] CHARS_A = { 'A' };
75 private static final char[] CHARS_AF = { 'A', 'F' };
76 private static final char[] CHARS_C = { 'C' };
77 private static final char[] CHARS_FF = { 'F', 'F' };
78 private static final char[] CHARS_G = { 'G' };
79 private static final char[] CHARS_N = { 'N' };
80 private static final char[] CHARS_NN = { 'N', 'N' };
81 private static final char[] CHARS_S = { 'S' };
82 private static final char[] CHARS_SSS = { 'S', 'S', 'S' };
83
84 private static final Pattern PAT_MAC = Pattern.compile("^MAC");
85 private static final Pattern PAT_KN = Pattern.compile("^KN");
86 private static final Pattern PAT_K = Pattern.compile("^K");
87 private static final Pattern PAT_PH_PF = Pattern.compile("^(PH|PF)");
88 private static final Pattern PAT_SCH = Pattern.compile("^SCH");
89 private static final Pattern PAT_EE_IE = Pattern.compile("(EE|IE)$");
90 private static final Pattern PAT_DT_ETC = Pattern.compile("(DT|RT|RD|NT|ND)$");
91
92 private static final char SPACE = ' ';
93 private static final int TRUE_LENGTH = 6;
94
95
96
97
98
99
100
101
102 private static boolean isVowel(final char c) {
103 return c == 'A' || c == 'E' || c == 'I' || c == 'O' || c == 'U';
104 }
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120 private static char[] transcodeRemaining(final char prev, final char curr, final char next, final char aNext) {
121
122 if (curr == 'E' && next == 'V') {
123 return CHARS_AF;
124 }
125
126
127 if (isVowel(curr)) {
128 return CHARS_A;
129 }
130
131
132
133
134 switch (curr) {
135 case 'Q':
136 return CHARS_G;
137 case 'Z':
138 return CHARS_S;
139 case 'M':
140 return CHARS_N;
141 case 'K':
142 if (next == 'N') {
143 return CHARS_NN;
144 }
145 return CHARS_C;
146 default:
147 break;
148 }
149
150
151 if (curr == 'S' && next == 'C' && aNext == 'H') {
152 return CHARS_SSS;
153 }
154
155
156 if (curr == 'P' && next == 'H') {
157 return CHARS_FF;
158 }
159
160
161 if (curr == 'H' && (!isVowel(prev) || !isVowel(next))) {
162 return new char[] { prev };
163 }
164
165
166 if (curr == 'W' && isVowel(prev)) {
167 return new char[] { prev };
168 }
169
170 return new char[] { curr };
171 }
172
173
174 private final boolean strict;
175
176
177
178
179
180 public Nysiis() {
181 this(true);
182 }
183
184
185
186
187
188
189
190
191
192
193
194
195 public Nysiis(final boolean strict) {
196 this.strict = strict;
197 }
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212 @Override
213 public Object encode(final Object obj) throws EncoderException {
214 if (!(obj instanceof String)) {
215 throw new EncoderException("Parameter supplied to Nysiis encode is not of type java.lang.String");
216 }
217 return this.nysiis((String) obj);
218 }
219
220
221
222
223
224
225
226
227
228
229 @Override
230 public String encode(final String str) {
231 return this.nysiis(str);
232 }
233
234
235
236
237
238
239 public boolean isStrict() {
240 return this.strict;
241 }
242
243
244
245
246
247
248
249
250 public String nysiis(String str) {
251 if (str == null) {
252 return null;
253 }
254
255
256 str = SoundexUtils.clean(str);
257
258 if (str.isEmpty()) {
259 return str;
260 }
261
262
263
264 str = PAT_MAC.matcher(str).replaceFirst("MCC");
265 str = PAT_KN.matcher(str).replaceFirst("NN");
266 str = PAT_K.matcher(str).replaceFirst("C");
267 str = PAT_PH_PF.matcher(str).replaceFirst("FF");
268 str = PAT_SCH.matcher(str).replaceFirst("SSS");
269
270
271
272 str = PAT_EE_IE.matcher(str).replaceFirst("Y");
273 str = PAT_DT_ETC.matcher(str).replaceFirst("D");
274
275
276 final StringBuilder key = new StringBuilder(str.length());
277 key.append(str.charAt(0));
278
279
280 final char[] chars = str.toCharArray();
281 final int len = chars.length;
282
283 for (int i = 1; i < len; i++) {
284 final char next = i < len - 1 ? chars[i + 1] : SPACE;
285 final char aNext = i < len - 2 ? chars[i + 2] : SPACE;
286 final char[] transcoded = transcodeRemaining(chars[i - 1], chars[i], next, aNext);
287 System.arraycopy(transcoded, 0, chars, i, transcoded.length);
288
289
290 if (chars[i] != chars[i - 1]) {
291 key.append(chars[i]);
292 }
293 }
294
295 if (key.length() > 1) {
296 char lastChar = key.charAt(key.length() - 1);
297
298
299 if (lastChar == 'S') {
300 key.deleteCharAt(key.length() - 1);
301 lastChar = key.charAt(key.length() - 1);
302 }
303
304 if (key.length() > 2) {
305 final char last2Char = key.charAt(key.length() - 2);
306
307 if (last2Char == 'A' && lastChar == 'Y') {
308 key.deleteCharAt(key.length() - 2);
309 }
310 }
311
312
313 if (lastChar == 'A') {
314 key.deleteCharAt(key.length() - 1);
315 }
316 }
317
318 final String string = key.toString();
319 return this.isStrict() ? string.substring(0, Math.min(TRUE_LENGTH, string.length())) : string;
320 }
321
322 }