1 |
alfonx |
244 |
/******************************************************************************* |
2 |
|
|
* Copyright (c) 2009 Martin O. J. Schmitz. |
3 |
|
|
* |
4 |
|
|
* This file is part of the SCHMITZM library - a collection of utility |
5 |
alfonx |
256 |
* classes based on Java 1.6, focusing (not only) on Java Swing |
6 |
alfonx |
244 |
* and the Geotools library. |
7 |
|
|
* |
8 |
|
|
* The SCHMITZM project is hosted at: |
9 |
|
|
* http://wald.intevation.org/projects/schmitzm/ |
10 |
|
|
* |
11 |
|
|
* This program is free software; you can redistribute it and/or |
12 |
|
|
* modify it under the terms of the GNU Lesser General Public License |
13 |
|
|
* as published by the Free Software Foundation; either version 3 |
14 |
|
|
* of the License, or (at your option) any later version. |
15 |
|
|
* |
16 |
|
|
* This program is distributed in the hope that it will be useful, |
17 |
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
18 |
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
19 |
|
|
* GNU General Public License for more details. |
20 |
|
|
* |
21 |
|
|
* You should have received a copy of the GNU Lesser General Public License (license.txt) |
22 |
|
|
* along with this program; if not, write to the Free Software |
23 |
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
24 |
|
|
* or try this link: http://www.gnu.org/licenses/lgpl.html |
25 |
|
|
* |
26 |
|
|
* Contributors: |
27 |
|
|
* Martin O. J. Schmitz - initial API and implementation |
28 |
alfonx |
862 |
* Stefan A. Tzeggai - additional utility classes |
29 |
alfonx |
244 |
******************************************************************************/ |
30 |
|
|
package skrueger.i8n; |
31 |
|
|
|
32 |
alfonx |
292 |
import java.awt.event.ActionEvent; |
33 |
|
|
import java.awt.event.ActionListener; |
34 |
alfonx |
244 |
import java.beans.PropertyChangeEvent; |
35 |
|
|
import java.beans.PropertyChangeListener; |
36 |
alfonx |
772 |
import java.io.Serializable; |
37 |
alfonx |
244 |
import java.util.ArrayList; |
38 |
|
|
import java.util.HashMap; |
39 |
alfonx |
482 |
import java.util.Iterator; |
40 |
alfonx |
244 |
import java.util.List; |
41 |
|
|
import java.util.Locale; |
42 |
alfonx |
292 |
import java.util.Random; |
43 |
alfonx |
607 |
import java.util.WeakHashMap; |
44 |
alfonx |
244 |
|
45 |
|
|
import javax.swing.JComponent; |
46 |
|
|
|
47 |
|
|
import org.apache.log4j.Logger; |
48 |
alfonx |
482 |
import org.geotools.util.WeakHashSet; |
49 |
alfonx |
409 |
import org.opengis.util.InternationalString; |
50 |
alfonx |
244 |
|
51 |
alfonx |
420 |
import skrueger.geotools.Copyable; |
52 |
|
|
|
53 |
alfonx |
244 |
/** |
54 |
|
|
* Represents a {@link HashMap} of translations. toString() returns the |
55 |
|
|
* appropriate translation |
56 |
|
|
* |
57 |
|
|
* @author @author <a href="mailto:[email protected]">Stefan Alfons |
58 |
|
|
* Krüger</a> |
59 |
|
|
*/ |
60 |
|
|
|
61 |
alfonx |
482 |
public class Translation extends HashMap<String, String> implements |
62 |
alfonx |
772 |
Copyable<Translation>, Serializable { |
63 |
|
|
|
64 |
|
|
private static final long serialVersionUID = -347702744122305245L; |
65 |
|
|
|
66 |
alfonx |
244 |
public static final String LOCALECHANGE_PROPERTY = "localechange"; |
67 |
|
|
public static final String NO_TRANSLATION = "NO TRANSLATION"; |
68 |
|
|
public static final String DEFAULT_KEY = "default"; |
69 |
alfonx |
486 |
static final Logger LOGGER = Logger.getLogger(Translation.class); |
70 |
alfonx |
268 |
static String activeLang = Locale.getDefault().getLanguage(); |
71 |
alfonx |
244 |
|
72 |
alfonx |
607 |
static protected WeakHashSet<PropertyChangeListener> listeners = new WeakHashSet<PropertyChangeListener>( |
73 |
|
|
PropertyChangeListener.class); |
74 |
alfonx |
244 |
|
75 |
|
|
static { |
76 |
|
|
|
77 |
|
|
// TODO default aus Locale auslesen und mit möglichen vergleichen... |
78 |
|
|
// mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht |
79 |
|
|
|
80 |
|
|
// Get default locale |
81 |
|
|
Locale locale = Locale.getDefault(); |
82 |
|
|
setActiveLang(locale.getLanguage()); |
83 |
|
|
} |
84 |
alfonx |
772 |
|
85 |
|
|
|
86 |
alfonx |
244 |
|
87 |
alfonx |
482 |
private WeakHashSet<ActionListener> actionListeners = new WeakHashSet<ActionListener>( |
88 |
|
|
ActionListener.class); |
89 |
alfonx |
292 |
|
90 |
alfonx |
244 |
@Override |
91 |
|
|
/* |
92 |
|
|
* @comment To make a copy of a translation see methods toOneLine() and |
93 |
|
|
* fromOneLine() |
94 |
|
|
*/ |
95 |
|
|
public Translation clone() { |
96 |
alfonx |
420 |
throw new RuntimeException("use copy()"); |
97 |
alfonx |
482 |
// return (Translation) super.clone(); |
98 |
alfonx |
244 |
} |
99 |
|
|
|
100 |
|
|
/** |
101 |
|
|
* Get the two-letter language sting that is active |
102 |
|
|
*/ |
103 |
|
|
public static String getActiveLang() { |
104 |
|
|
return activeLang; |
105 |
|
|
} |
106 |
|
|
|
107 |
|
|
/** |
108 |
|
|
* Set up the {@link Translation}-system to use language. If a change is |
109 |
|
|
* performed, events are fired to listeners. Nothing is done if the new |
110 |
|
|
* language equals the old language. The system's default locale is changed. |
111 |
|
|
* |
112 |
|
|
* @param newLang |
113 |
|
|
* The ISO Code of the new active language |
114 |
|
|
*/ |
115 |
|
|
public static void setActiveLang(String newLang) { |
116 |
|
|
setActiveLang(newLang, true); |
117 |
|
|
} |
118 |
|
|
|
119 |
|
|
/** |
120 |
|
|
* Set up the {@link Translation}-system to use language. If a change is |
121 |
|
|
* performed, events are fired to listeners. Nothing is done if the new |
122 |
|
|
* language equals the old language. |
123 |
|
|
* |
124 |
|
|
* @param newLang |
125 |
|
|
* The ISO Code of the new active language |
126 |
|
|
* |
127 |
|
|
* @param setDefaultLocale |
128 |
|
|
* Shall the system's default locale be changed? |
129 |
|
|
*/ |
130 |
|
|
public static void setActiveLang(String newLang, boolean setDefaultLocale) { |
131 |
|
|
if (getActiveLang().equals(newLang)) { |
132 |
|
|
return; |
133 |
|
|
} |
134 |
|
|
|
135 |
|
|
if (!I8NUtil.isValidISOLangCode(newLang)) { |
136 |
|
|
throw new IllegalArgumentException("'" + newLang |
137 |
|
|
+ "' is not a valid ISO language code."); |
138 |
|
|
} |
139 |
|
|
|
140 |
|
|
Locale newLocale = new Locale(newLang); |
141 |
|
|
if (setDefaultLocale) |
142 |
|
|
Locale.setDefault(newLocale); |
143 |
|
|
|
144 |
|
|
/** |
145 |
|
|
* Setting default locale for Swing JComponents to work around bug |
146 |
|
|
* http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480 |
147 |
|
|
*/ |
148 |
|
|
JComponent.setDefaultLocale(newLocale); |
149 |
|
|
|
150 |
|
|
Translation.activeLang = newLang; |
151 |
|
|
|
152 |
|
|
fireLocaleChangeEvents(); |
153 |
|
|
|
154 |
alfonx |
607 |
LOGGER.info("skrueger.i8n.Translation switched ActiveLang to " |
155 |
|
|
+ newLang); |
156 |
alfonx |
244 |
} |
157 |
|
|
|
158 |
|
|
/** |
159 |
|
|
* Initializes a new {@link Translation} with a default translation if a |
160 |
|
|
* simple text is passed. If a "oneLine" text is parsed, it is interpreted. |
161 |
|
|
* Other translations may be added later - this is a HashMap<br/> |
162 |
|
|
* |
163 |
|
|
* @param defaultTranslation |
164 |
|
|
* |
165 |
|
|
* @see public Translation(List<String> languages, String |
166 |
|
|
* defaultTranslation) { |
167 |
|
|
* |
168 |
|
|
*/ |
169 |
|
|
public Translation(String defaultTranslation) { |
170 |
|
|
|
171 |
|
|
fromOneLine(defaultTranslation); |
172 |
|
|
|
173 |
|
|
} |
174 |
|
|
|
175 |
|
|
/** |
176 |
|
|
* Initializes a new {@link Translation}, an uses the given String to |
177 |
|
|
* initialize the {@link Translation} for all languages codes passed. |
178 |
|
|
* |
179 |
|
|
* The translations can be changed later |
180 |
|
|
*/ |
181 |
|
|
public Translation(List<String> languages, String defaultTranslation) { |
182 |
|
|
// put(DEFAULT_KEY, defaultTranslation); |
183 |
|
|
if (languages == null) { |
184 |
|
|
put(DEFAULT_KEY, defaultTranslation); |
185 |
|
|
} else |
186 |
|
|
for (String code : languages) { |
187 |
alfonx |
615 |
// if (code.equals(getActiveLang())) { |
188 |
alfonx |
244 |
put(code, defaultTranslation); |
189 |
alfonx |
615 |
// } |
190 |
alfonx |
244 |
} |
191 |
|
|
} |
192 |
|
|
|
193 |
|
|
/** |
194 |
|
|
* Sometimes Translations are optional, like for keywords. |
195 |
|
|
*/ |
196 |
|
|
public Translation() { |
197 |
|
|
} |
198 |
|
|
|
199 |
|
|
/** |
200 |
|
|
* Fills the {@link Translation} with the values coded into the String |
201 |
|
|
* Format of {@link String} is: "de{Baum}en{tree}" |
202 |
|
|
* <p> |
203 |
|
|
* <ul> |
204 |
|
|
* <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set. |
205 |
|
|
* <li>If format can't be recognized, the {@link String} is interpreted as |
206 |
|
|
* the translation in the <code>{@value #DEFAULT_KEY}</code> language |
207 |
|
|
* |
208 |
alfonx |
862 |
* @author Stefan Alfons Tzeggai |
209 |
alfonx |
244 |
*/ |
210 |
|
|
public void fromOneLine(final String oneLineCoded) { |
211 |
alfonx |
420 |
|
212 |
alfonx |
244 |
clear(); |
213 |
alfonx |
482 |
|
214 |
alfonx |
420 |
try { |
215 |
alfonx |
244 |
|
216 |
alfonx |
482 |
if ((oneLineCoded == null) || (oneLineCoded.equals(""))) { |
217 |
|
|
put(DEFAULT_KEY, ""); |
218 |
|
|
return; |
219 |
|
|
} |
220 |
alfonx |
244 |
|
221 |
alfonx |
482 |
if (oneLineCoded.indexOf("}") == -1) { |
222 |
|
|
// log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);"); |
223 |
|
|
put(DEFAULT_KEY, oneLineCoded); |
224 |
|
|
} |
225 |
alfonx |
244 |
|
226 |
alfonx |
482 |
String eatUp = oneLineCoded; |
227 |
|
|
while (eatUp.indexOf("}") != -1) { |
228 |
|
|
String substring = eatUp.substring(0, eatUp.indexOf("}")); |
229 |
|
|
|
230 |
|
|
// log.debug("substring = "+substring); |
231 |
|
|
String key = substring.substring(0, substring.indexOf("{")); |
232 |
|
|
String value = substring.substring(substring.indexOf("{") + 1, |
233 |
|
|
substring.length()); |
234 |
|
|
// log.debug("key="+key); |
235 |
|
|
// log.debug("value="+value); |
236 |
|
|
put(key, value); |
237 |
|
|
eatUp = eatUp.substring(eatUp.indexOf("}") + 1); |
238 |
|
|
} |
239 |
alfonx |
420 |
} catch (Exception e) { |
240 |
alfonx |
486 |
LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded |
241 |
alfonx |
482 |
+ "'", e); |
242 |
alfonx |
486 |
LOGGER.warn("Translation will be empty!"); |
243 |
alfonx |
420 |
} |
244 |
alfonx |
244 |
} |
245 |
|
|
|
246 |
|
|
/** |
247 |
|
|
* Exports the Translations to a String of the Format: "de{Baum}en{tree}" |
248 |
|
|
* |
249 |
alfonx |
862 |
* @author Stefan Alfons Tzeggai |
250 |
alfonx |
244 |
*/ |
251 |
|
|
public String toOneLine() { |
252 |
|
|
return I8NUtil.toOneLine(this); |
253 |
|
|
} |
254 |
|
|
|
255 |
|
|
/** |
256 |
|
|
* Returns the right translation by using the {@link #activeLang} field. If |
257 |
|
|
* no translation is set, an ugly String {@link #NO_TRANSLATION} will re |
258 |
|
|
* returned. This might be changed for the final release. If the correct |
259 |
|
|
* language was not found, any entry in the {@link Translation} |
260 |
|
|
* {@link HashMap} will be returned, that contains more than an empty |
261 |
|
|
* string. |
262 |
|
|
*/ |
263 |
|
|
@Override |
264 |
|
|
public String toString() { |
265 |
|
|
if (get(activeLang) != null) { |
266 |
|
|
return get(activeLang); |
267 |
|
|
} |
268 |
|
|
// **************************************************************************** |
269 |
|
|
// MS: The ISDSS needs the concept of the default lang!! So I took the |
270 |
|
|
// following in again!! |
271 |
|
|
// **************************************************************************** |
272 |
|
|
// else return ""; |
273 |
|
|
// //**************************************************************************** |
274 |
|
|
// // The following is commented out.. the concept of the default lang |
275 |
|
|
// seems to be bad.... |
276 |
|
|
// //**************************************************************************** |
277 |
|
|
// MS: |
278 |
|
|
else { |
279 |
|
|
if (get(DEFAULT_KEY) != null) { |
280 |
|
|
return get(DEFAULT_KEY); |
281 |
|
|
} |
282 |
|
|
|
283 |
|
|
// log.debug("return first best <> '' "); |
284 |
|
|
if (size() > 0) |
285 |
|
|
for (String s : values()) { |
286 |
|
|
if ((s != null) && (s.trim().length() > 0)) |
287 |
|
|
return s; |
288 |
|
|
} |
289 |
|
|
} |
290 |
alfonx |
482 |
// log.warn("No translation found!"); |
291 |
alfonx |
244 |
return NO_TRANSLATION; |
292 |
|
|
} |
293 |
|
|
|
294 |
|
|
/** |
295 |
|
|
* {@link PropertyChangeListener} can be registered to be informed when the |
296 |
alfonx |
607 |
* {@link Locale} changed.<br> |
297 |
|
|
* The listeners are kept in a {@link WeakHashMap}, so you have to keep a |
298 |
|
|
* reference to the listener or it will be removed! |
299 |
alfonx |
244 |
* |
300 |
|
|
* @param propertyChangeListener |
301 |
alfonx |
607 |
* A {@link PropertyChangeListener} that will be called when |
302 |
|
|
* {@link #setActiveLang(String)} changes the language. |
303 |
alfonx |
244 |
*/ |
304 |
|
|
public static void addLocaleChangeListener( |
305 |
|
|
PropertyChangeListener propertyChangeListener) { |
306 |
|
|
listeners.add(propertyChangeListener); |
307 |
|
|
} |
308 |
|
|
|
309 |
|
|
/** |
310 |
alfonx |
607 |
* {@link PropertyChangeListener} can be registered to be informed when the |
311 |
|
|
* {@link Locale} changed.<br> |
312 |
|
|
* The listeners are kept in a {@link WeakHashMap}, so you have to keep a |
313 |
|
|
* reference to the listener or it will be removed! |
314 |
|
|
* |
315 |
|
|
* @param propertyChangeListener |
316 |
|
|
* A {@link PropertyChangeListener} that will be called when |
317 |
|
|
* {@link #setActiveLang(String)} changes the language. |
318 |
|
|
*/ |
319 |
|
|
public static boolean removeLocaleChangeListener( |
320 |
|
|
PropertyChangeListener propertyChangeListener) { |
321 |
|
|
return listeners.remove(propertyChangeListener); |
322 |
|
|
} |
323 |
|
|
|
324 |
|
|
/** |
325 |
alfonx |
244 |
* Informs all registered {@link PropertyChangeListener}s about a change of |
326 |
|
|
* the the {@link Locale}. |
327 |
|
|
*/ |
328 |
|
|
public static void fireLocaleChangeEvents() { |
329 |
|
|
PropertyChangeEvent pce = new PropertyChangeEvent(new Translation( |
330 |
|
|
new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY, |
331 |
|
|
null, getActiveLang()); |
332 |
|
|
for (PropertyChangeListener pcl : listeners) { |
333 |
|
|
if (pcl != null) |
334 |
|
|
pcl.propertyChange(pce); |
335 |
|
|
} |
336 |
|
|
} |
337 |
|
|
|
338 |
alfonx |
482 |
/** |
339 |
|
|
* The listeneras are stored in a {@link WeakHashSet}! So you HAVE TO KEEP a |
340 |
|
|
* reference as long as you need the listener. |
341 |
|
|
*/ |
342 |
alfonx |
292 |
public void addTranslationChangeListener(ActionListener actionListener) { |
343 |
alfonx |
486 |
if (actionListeners.add(actionListener)) { |
344 |
alfonx |
723 |
// LOGGER |
345 |
|
|
// .debug("registering a new translationChangeActionListener in the WeakHashSet"); |
346 |
alfonx |
486 |
} |
347 |
alfonx |
292 |
} |
348 |
alfonx |
482 |
|
349 |
|
|
/** |
350 |
|
|
* The listeneras are stored in a {@link WeakHashSet}! You don't have to |
351 |
|
|
* remove the listener, as long as you throw away the reference to the |
352 |
|
|
* listener. |
353 |
|
|
*/ |
354 |
alfonx |
292 |
public boolean removeTranslationChangeListener(ActionListener actionListener) { |
355 |
|
|
return actionListeners.remove(actionListener); |
356 |
|
|
} |
357 |
|
|
|
358 |
alfonx |
300 |
public void fireTranslationChangedEvents(String lang) { |
359 |
|
|
ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang); |
360 |
alfonx |
482 |
|
361 |
|
|
final Iterator<ActionListener> iterator = actionListeners.iterator(); |
362 |
|
|
while (iterator.hasNext()) { |
363 |
|
|
ActionListener al = iterator.next(); |
364 |
|
|
al.actionPerformed(ae); |
365 |
alfonx |
292 |
} |
366 |
|
|
} |
367 |
alfonx |
482 |
|
368 |
alfonx |
292 |
@Override |
369 |
alfonx |
300 |
public String put(String lang, String value) { |
370 |
|
|
String result = super.put(lang, value); |
371 |
|
|
fireTranslationChangedEvents(lang); |
372 |
alfonx |
292 |
return result; |
373 |
|
|
} |
374 |
alfonx |
409 |
|
375 |
|
|
public void fromOneLine(InternationalString iString) { |
376 |
|
|
if (iString != null) |
377 |
|
|
fromOneLine(iString.toString()); |
378 |
alfonx |
482 |
else |
379 |
|
|
fromOneLine((String) null); |
380 |
alfonx |
409 |
} |
381 |
alfonx |
482 |
|
382 |
alfonx |
420 |
/** |
383 |
|
|
* Copy this {@link Translation} to another {@link Translation} e.g. for |
384 |
|
|
* editing |
385 |
|
|
* |
386 |
|
|
* @return the destination {@link Translation} |
387 |
|
|
*/ |
388 |
|
|
@Override |
389 |
|
|
public Translation copyTo(Translation translation2) { |
390 |
alfonx |
482 |
|
391 |
alfonx |
420 |
if (translation2 == null) |
392 |
alfonx |
482 |
// throw new IllegalArgumentException( |
393 |
|
|
// "Target translation may not be null."); |
394 |
|
|
return copy(); |
395 |
alfonx |
420 |
for (String s : keySet()) { |
396 |
|
|
translation2.put(s, get(s)); |
397 |
|
|
} |
398 |
alfonx |
482 |
|
399 |
alfonx |
420 |
return translation2; |
400 |
|
|
} |
401 |
|
|
|
402 |
|
|
@Override |
403 |
|
|
public Translation copy() { |
404 |
|
|
return copyTo(new Translation()); |
405 |
|
|
} |
406 |
|
|
|
407 |
|
|
/** |
408 |
alfonx |
482 |
* Checks if the {@link String}s stored in the {@link Translation} are all |
409 |
|
|
* valid. |
410 |
|
|
* |
411 |
alfonx |
420 |
* @return <code>true</code> if all good |
412 |
|
|
*/ |
413 |
|
|
public static boolean checkValid(Translation translationToCheck) { |
414 |
alfonx |
482 |
|
415 |
alfonx |
420 |
for (String l : translationToCheck.values()) { |
416 |
alfonx |
482 |
|
417 |
alfonx |
420 |
if (l.contains("{") || l.contains("}")) { |
418 |
alfonx |
482 |
|
419 |
alfonx |
420 |
return false; |
420 |
|
|
} |
421 |
|
|
} |
422 |
|
|
return true; |
423 |
|
|
} |
424 |
alfonx |
482 |
|
425 |
alfonx |
244 |
} |