skrueger/i8n/Translation.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Krüger - additional utility classes
 ******************************************************************************/
package skrueger.i8n;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Random;

import javax.swing.JComponent;

import org.apache.log4j.Logger;
import org.geotools.util.WeakHashSet;
import org.opengis.util.InternationalString;

import skrueger.geotools.Copyable;

/**
 * Represents a {@link HashMap} of translations. toString() returns the
 * appropriate translation
 * 
 * @author @author <a href="mailto:[email protected]">Stefan Alfons
 *         Kr&uuml;ger</a>
 */

public class Translation extends HashMap<String, String> implements
                Copyable<Translation> {
        public static final String LOCALECHANGE_PROPERTY = "localechange";
        public static final String NO_TRANSLATION = "NO TRANSLATION";
        public static final String DEFAULT_KEY = "default";
        static final Logger log = Logger.getLogger(Translation.class);
        static String activeLang = Locale.getDefault().getLanguage();

        static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();

        static {

                // TODO default aus Locale auslesen und mit möglichen vergleichen...
                // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht

                // Get default locale
                Locale locale = Locale.getDefault();
                setActiveLang(locale.getLanguage());
        }

        private WeakHashSet<ActionListener> actionListeners = new WeakHashSet<ActionListener>(
                        ActionListener.class);

        @Override
        /*
         * @comment To make a copy of a translation see methods toOneLine() and
         * fromOneLine()
         */
        public Translation clone() {
                throw new RuntimeException("use copy()");
                // return (Translation) super.clone();
        }

        /**
         * Get the two-letter language sting that is active
         */
        public static String getActiveLang() {
                return activeLang;
        }

        /**
         * Set up the {@link Translation}-system to use language. If a change is
         * performed, events are fired to listeners. Nothing is done if the new
         * language equals the old language. The system's default locale is changed.
         * 
         * @param newLang
         *            The ISO Code of the new active language
         */
        public static void setActiveLang(String newLang) {
                setActiveLang(newLang, true);
        }

        /**
         * Set up the {@link Translation}-system to use language. If a change is
         * performed, events are fired to listeners. Nothing is done if the new
         * language equals the old language.
         * 
         * @param newLang
         *            The ISO Code of the new active language
         * 
         * @param setDefaultLocale
         *            Shall the system's default locale be changed?
         */
        public static void setActiveLang(String newLang, boolean setDefaultLocale) {
                if (getActiveLang().equals(newLang)) {
                        return;
                }

                if (!I8NUtil.isValidISOLangCode(newLang)) {
                        throw new IllegalArgumentException("'" + newLang
                                        + "' is not a valid ISO language code.");
                }

                Locale newLocale = new Locale(newLang);
                if (setDefaultLocale)
                        Locale.setDefault(newLocale);

                /**
                 * Setting default locale for Swing JComponents to work around bug
                 * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
                 */
                JComponent.setDefaultLocale(newLocale);

                Translation.activeLang = newLang;

                fireLocaleChangeEvents();

                log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
        }

        /**
         * Initializes a new {@link Translation} with a default translation if a
         * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
         * Other translations may be added later - this is a HashMap<br/>
         * 
         * @param defaultTranslation
         * 
         * @see public Translation(List<String> languages, String
         *      defaultTranslation) {
         * 
         */
        public Translation(String defaultTranslation) {

                fromOneLine(defaultTranslation);

        }

        /**
         * Initializes a new {@link Translation}, an uses the given String to
         * initialize the {@link Translation} for all languages codes passed.
         * 
         * The translations can be changed later
         */
        public Translation(List<String> languages, String defaultTranslation) {
                // put(DEFAULT_KEY, defaultTranslation);
                if (languages == null) {
                        put(DEFAULT_KEY, defaultTranslation);
                } else
                        for (String code : languages) {
                                if (code.equals(getActiveLang())) {
                                        put(code, defaultTranslation);
                                }
                        }
        }

        /**
         * Sometimes Translations are optional, like for keywords.
         */
        public Translation() {
        }

        /**
         * Fills the {@link Translation} with the values coded into the String
         * Format of {@link String} is: "de{Baum}en{tree}"
         * <p>
         * <ul>
         * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
         * <li>If format can't be recognized, the {@link String} is interpreted as
         * the translation in the <code>{@value #DEFAULT_KEY}</code> language
         * 
         * @author Stefan Alfons Krüger
         */
        public void fromOneLine(final String oneLineCoded) {

                clear();

                try {

                        if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
                                put(DEFAULT_KEY, "");
                                return;
                        }

                        if (oneLineCoded.indexOf("}") == -1) {
                                // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
                                put(DEFAULT_KEY, oneLineCoded);
                        }

                        String eatUp = oneLineCoded;
                        while (eatUp.indexOf("}") != -1) {
                                String substring = eatUp.substring(0, eatUp.indexOf("}"));

                                // log.debug("substring = "+substring);
                                String key = substring.substring(0, substring.indexOf("{"));
                                String value = substring.substring(substring.indexOf("{") + 1,
                                                substring.length());
                                // log.debug("key="+key);
                                // log.debug("value="+value);
                                put(key, value);
                                eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
                        }
                } catch (Exception e) {
                        log.warn("Error while reading the oneLineCode '" + oneLineCoded
                                        + "'", e);
                        log.warn("Translation will be empty!");
                }
        }

        /**
         * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
         * 
         * @author Stefan Alfons Krüger
         */
        public String toOneLine() {
                return I8NUtil.toOneLine(this);
        }

        /**
         * Returns the right translation by using the {@link #activeLang} field. If
         * no translation is set, an ugly String {@link #NO_TRANSLATION} will re
         * returned. This might be changed for the final release. If the correct
         * language was not found, any entry in the {@link Translation}
         * {@link HashMap} will be returned, that contains more than an empty
         * string.
         */
        @Override
        public String toString() {
                if (get(activeLang) != null) {
                        return get(activeLang);
                }
                // ****************************************************************************
                // MS: The ISDSS needs the concept of the default lang!! So I took the
                // following in again!!
                // ****************************************************************************
                // else return "";
                // //****************************************************************************
                // // The following is commented out.. the concept of the default lang
                // seems to be bad....
                // //****************************************************************************
                // MS:
                else {
                        if (get(DEFAULT_KEY) != null) {
                                return get(DEFAULT_KEY);
                        }

                        // log.debug("return first best <> '' ");
                        if (size() > 0)
                                for (String s : values()) {
                                        if ((s != null) && (s.trim().length() > 0))
                                                return s;
                                }
                }
                // log.warn("No translation found!");
                return NO_TRANSLATION;
        }

        /**
         * {@link PropertyChangeListener} can be registered to be informed when the
         * {@link Locale} changed.
         * 
         * @param propertyChangeListener
         */
        public static void addLocaleChangeListener(
                        PropertyChangeListener propertyChangeListener) {
                listeners.add(propertyChangeListener);
        }

        /**
         * Informs all registered {@link PropertyChangeListener}s about a change of
         * the the {@link Locale}.
         */
        public static void fireLocaleChangeEvents() {
                PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
                                new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,
                                null, getActiveLang());
                for (PropertyChangeListener pcl : listeners) {
                        if (pcl != null)
                                pcl.propertyChange(pce);
                }
        }

        /**
         * The listeneras are stored in a {@link WeakHashSet}! So you HAVE TO KEEP a
         * reference as long as you need the listener.
         */
        public void addTranslationChangeListener(ActionListener actionListener) {
                actionListeners.add(actionListener);
        }

        /**
         * The listeneras are stored in a {@link WeakHashSet}! You don't have to
         * remove the listener, as long as you throw away the reference to the
         * listener.
         */
        public boolean removeTranslationChangeListener(ActionListener actionListener) {
                return actionListeners.remove(actionListener);
        }

        public void fireTranslationChangedEvents(String lang) {
                ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);

                final Iterator<ActionListener> iterator = actionListeners.iterator();
                while (iterator.hasNext()) {
                        ActionListener al = iterator.next();
                        al.actionPerformed(ae);
                }
        }

        @Override
        public String put(String lang, String value) {
                String result = super.put(lang, value);
                fireTranslationChangedEvents(lang);
                return result;
        }

        public void fromOneLine(InternationalString iString) {
                if (iString != null)
                        fromOneLine(iString.toString());
                else
                        fromOneLine((String) null);
        }

        /**
         * Copy this {@link Translation} to another {@link Translation} e.g. for
         * editing
         * 
         * @return the destination {@link Translation}
         */
        @Override
        public Translation copyTo(Translation translation2) {

                if (translation2 == null)
                        // throw new IllegalArgumentException(
                        // "Target translation may not be null.");
                        return copy();
                for (String s : keySet()) {
                        translation2.put(s, get(s));
                }

                return translation2;
        }

        @Override
        public Translation copy() {
                return copyTo(new Translation());
        }

        /**
         * Checks if the {@link String}s stored in the {@link Translation} are all
         * valid.
         * 
         * @return <code>true</code> if all good
         */
        public static boolean checkValid(Translation translationToCheck) {

                for (String l : translationToCheck.values()) {

                        if (l.contains("{") || l.contains("}")) {

                                return false;
                        }
                }
                return true;
        }

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