|
23 | 23 | import org.apache.commons.codec.StringEncoder; |
24 | 24 |
|
25 | 25 | /** |
26 | | - * <h1>ColognePhonetic</h1> |
27 | | - * |
28 | 26 | * <p> |
29 | | - * <b>ColognePhonetic</b> provides an implementation of the <a |
30 | | - * href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">“Kölner |
31 | | - * Phonetic”</a> (cologne phonetic) algorithm issued by Hans Joachim Postel in |
32 | | - * 1969. |
| 27 | + * Implements of the <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">“Kölner Phonetic”</a> (cologne |
| 28 | + * phonetic) algorithm issued by Hans Joachim Postel in 1969. |
33 | 29 | * </p> |
34 | 30 | * |
35 | 31 | * <p> |
36 | | - * The <i>Kölner Phonetik</i> is a phonetic algorithm which is optimized for the |
37 | | - * German language. It is related to the well-known soundex algorithm. |
| 32 | + * The <i>Kölner Phonetik</i> is a phonetic algorithm which is optimized for the German language. It is related to the |
| 33 | + * well-known soundex algorithm. |
38 | 34 | * </p> |
39 | 35 | * |
40 | 36 | * <h2>Algorithm</h2> |
|
44 | 40 | * <li> |
45 | 41 | * <h3>First step:</h3> |
46 | 42 | * After a preprocessing (convertion to upper case, transcription of <a |
47 | | - * href="http://en.wikipedia.org/wiki/Germanic_umlaut">germanic umlauts</a>, |
48 | | - * removal of non alphabetical characters) the letters of the supplied text are |
49 | | - * replaced by their phonetic code according to the folowing table. |
| 43 | + * href="http://en.wikipedia.org/wiki/Germanic_umlaut">germanic umlauts</a>, removal of non alphabetical characters) the |
| 44 | + * letters of the supplied text are replaced by their phonetic code according to the folowing table. |
50 | 45 | * <table border="1"> |
51 | 46 | * <tbody> |
52 | 47 | * <tr> |
|
152 | 147 | * </tbody> |
153 | 148 | * </table> |
154 | 149 | * <p> |
155 | | - * <small><i>(Source: <a href= |
156 | | - * "http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik#Buchstabencodes" |
157 | | - * >Wikipedia (de): Kölner Phonetik – Buchstabencodes</a>)</i></small> |
| 150 | + * <small><i>(Source: <a href= "http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik#Buchstabencodes" >Wikipedia (de): |
| 151 | + * Kölner Phonetik – Buchstabencodes</a>)</i></small> |
158 | 152 | * </p> |
159 | 153 | * |
160 | 154 | * <h4>Example:</h4> |
|
178 | 172 | * |
179 | 173 | * </ul> |
180 | 174 | * |
181 | | - * @see<ul> <li><a |
182 | | - * href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik"><span |
183 | | - * style="font-variant:small-caps">Wikipedia</span> (de): <i>Kölner |
184 | | - * Phonetik</i></a>—for German description of the algorithm and more |
185 | | - * sources.</li> <li>{@linkplain #colognePhonetic(String)}—for the |
186 | | - * description of the actual implementation</li> <li> |
187 | | - * {@linkplain #isCologneEqual(String, String)}</li> <li> |
188 | | - * {@linkplain StringEncoder}—for the interface implemented by this |
189 | | - * class</li> </ul> |
190 | | - * |
| 175 | + * @see <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik"><span |
| 176 | + * style="font-variant:small-caps">Wikipedia</span> (de): <i>Kölner Phonetik</i></a> (a German description of the |
| 177 | + * algorithm and more sources) |
191 | 178 | * @author Apache Software Foundation |
192 | | - * @version 1.5 |
| 179 | + * @since 1.5 |
193 | 180 | */ |
194 | | - |
195 | 181 | public class ColognePhonetic implements StringEncoder { |
196 | 182 |
|
197 | 183 | private class CologneLeftBuffer implements CharSequence { |
|
0 commit comments