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