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. Tzeggai - 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.io.Serializable;
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 java.util.Set;
import java.util.WeakHashMap;

import javax.swing.JComponent;

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

import schmitzm.lang.ResourceProvider;
import schmitzm.lang.SortableVector;
import skrueger.geotools.Copyable;

/**
 * Represents a {@link HashMap} of translations. toString() returns the
 * appropriate translation. This class is mutable.
 * 
 * @author <a href="mailto:[email protected]">Stefan Alfons Tzeggai</a>
 */

public class Translation extends HashMap<String, String> implements
                Copyable<Translation>, Serializable, Cloneable {

        private static final long serialVersionUID = -347702744122305245L;

        public static final String LOCALE_CHANGE_PROPERTY = "localechange";
        public static final String ACTIVELANG_CHANGE_PROPERTY = "activelangchange";
        public static final String NO_TRANSLATION = "NO TRANSLATION";
        public static final String DEFAULT_KEY = "default";
        static final Logger LOGGER = Logger.getLogger(Translation.class);

        /** A static field defining which language should be served **/
        static String activeLang = Locale.getDefault().getLanguage();

        /**
         * A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
         * informed if the acitveLang has been changed with a setActiveLang(..,true
         * or false).
         */
        static protected WeakHashSet<PropertyChangeListener> listenersActiveLangChange = new WeakHashSet<PropertyChangeListener>(
                        PropertyChangeListener.class);

        /**
         * A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
         * informed if the Locale has been changed due to a setActiveLang(..,true)
         */
        static protected WeakHashSet<PropertyChangeListener> listenersLocaleChange = new WeakHashSet<PropertyChangeListener>(
                        PropertyChangeListener.class);

        /**
         * A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
         * informed if any of the translations changed. TODO: Should be registerable
         * for specific languages
         */
        private final WeakHashSet<ActionListener> changeListeners = new WeakHashSet<ActionListener>(
                        ActionListener.class);

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

        @Override
        /**
         * implemented using #toOneLine and #fromOneLine 
         */
        public Translation clone() {
                Translation clone = new Translation();
                clone.fromOneLine(toOneLine());
                return 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 {@link 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)) {

                        if (!I8NUtil.isPropertiesLanguage(newLang)) {
                                throw new IllegalArgumentException(
                                                "'"
                                                                + newLang
                                                                + "' is not a valid ISO language code, nor is it a valid userdefined Properties code.");
                        }

                }

                Translation.activeLang = newLang;
                fireActiveLangChangeEvents();

                Locale newLocale = new Locale(newLang);
                if (setDefaultLocale) {

                        setDefaultLocale(newLocale);

                        LOGGER.info(Translation.class.getName()
                                        + " switched ActiveLang and Locale to " + newLang);
                } else {
                        LOGGER.info(Translation.class.getName()
                                        + " 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. This class is not immutable.
         * 
         * @param languages
         *            if empty or null, the given default {@link Translation} till
         *            be stored under a special key {@link #DEFAULT_KEY}
         * 
         * 
         */
        public Translation(List<String> languages, String defaultTranslation) {
                if (languages == null || languages.isEmpty()) {
                        put(DEFAULT_KEY, defaultTranslation);
                } else
                        for (String code : languages) {
                                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 Tzeggai
         */
        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) {
                        LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded
                                        + "'", e);
                        LOGGER.warn("Translation will be empty!");
                }
        }

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

        /**
         * Returns the correct 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() {
                final String string = get(activeLang);
                if (string != null) {
                        return get(activeLang);
                }
                // ****************************************************************************
                // MS: The ISDSS needs the concept of the default lang!! So I took the
                // following in again!!
                // ****************************************************************************
                // else return "";
                // //****************************************************************************
                // // ST: 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.<br>
         * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
         * reference to the listener or it will be removed!
         * 
         * @param propertyChangeListener
         *            A {@link PropertyChangeListener} that will be called when
         *            {@link #setActiveLang(String)} changes the language.
         */
        public static void addLocaleChangeListener(
                        PropertyChangeListener propertyChangeListener) {
                listenersLocaleChange.add(propertyChangeListener);
        }

        /**
         * {@link PropertyChangeListener} can be registered to be informed when the
         * {@link Locale} changed.<br>
         * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
         * reference to the listener or it will be removed!
         * 
         * @param propertyChangeListener
         *            A {@link PropertyChangeListener} that will be called when
         *            {@link #setActiveLang(String)} changes the language.
         */
        public static boolean removeLocaleChangeListener(
                        PropertyChangeListener propertyChangeListener) {
                return listenersLocaleChange.remove(propertyChangeListener);
        }

        /**
         * {@link PropertyChangeListener} can be registered to be informed when the
         * {@link Locale} changed.<br>
         * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
         * reference to the listener or it will be removed!
         * 
         * @param propertyChangeListener
         *            A {@link PropertyChangeListener} that will be called when
         *            {@link #setActiveLang(String)} changes the language.
         */
        public static void addActiveLangChangeListener(
                        PropertyChangeListener propertyChangeListener) {
                listenersActiveLangChange.add(propertyChangeListener);
        }

        /**
         * {@link PropertyChangeListener} can be registered to be informed when the
         * {@link Locale} changed.<br>
         * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
         * reference to the listener or it will be removed!
         * 
         * @param propertyChangeListener
         *            A {@link PropertyChangeListener} that will be called when
         *            {@link #setActiveLang(String)} changes the language.
         */
        public static boolean removeActiveLangListener(
                        PropertyChangeListener propertyChangeListener) {
                return listenersActiveLangChange.remove(propertyChangeListener);
        }

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

        /**
         * Informs all registered {@link PropertyChangeListener}s about a change of
         * type ACTIVELANG_CHANGE_PROPERTY the the {@link Locale}.
         */
        public static void fireActiveLangChangeEvents() {
                PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
                                new ArrayList<String>(), "fakeSource"),
                                ACTIVELANG_CHANGE_PROPERTY, null, getActiveLang());
                for (PropertyChangeListener pcl : listenersActiveLangChange) {
                        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) {
                if (changeListeners.add(actionListener)) {
                        // LOGGER
                        // .debug("registering a new translationChangeActionListener in the WeakHashSet");
                }
        }

        /**
         * 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 changeListeners.remove(actionListener);
        }

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

                final Iterator<ActionListener> iterator = changeListeners.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 and return the target.
         * 
         * @return the destination {@link Translation}
         */
        @Override
        public Translation copyTo(Translation translation2) {
                if (translation2 == null)
                        return copy();

                translation2.fromOneLine(toOneLine());
                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;
        }

        /**
         * Goes through the available languages of the FIRST registered
         * {@link ResourceProvider} and set the active locale to the fist match.
         * 
         * @param fireChangeEvent
         *            if <code>true</code>, a Translation.fireLocaleChangeEvents()
         *            is issued.
         * 
         * @return
         */
        public static boolean setFirstmatchingLanguage(List<String> languages,
                        boolean fireChangeEvent) {

                SortableVector<ResourceProvider> registeredResourceProvider = ResourceProvider
                                .getRegisteredResourceProvider();
                Set<Locale> available = ResourceProvider.getAvailableLocales(
                                registeredResourceProvider.get(0), true);

                for (String l : languages) {
                        for (Locale loc : available) {
                                if (loc.getLanguage().equals(l)) {
                                        Translation.setActiveLang(l);
                                        if (fireChangeEvent)
                                                Translation.fireLocaleChangeEvents();
                                        return true;
                                }
                        }
                }

                return false;

        }

        /**
         * Returns the translation in a requested language
         */
        public String toString(String lang) {
                return get(lang);
        }

        /**
         * Will set the default Locale (if not already equal) and fire Locale change
         * events.
         * 
         * @param if <code>null</code> will do nothing.
         */
        public static void setDefaultLocale(Locale locale) {

                if (locale == null)
                        return;

                if (I8NUtil.isPropertiesLanguage(locale.getLanguage())) {
                        locale = I8NUtil.propLocales.get(locale.getLanguage())
                                        .getParentLocale();
                }

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

                fireLocaleChangeEvents();
        }

}
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. Tzeggai - 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.io.Serializable;
37	import java.util.ArrayList;
38	import java.util.HashMap;
39	import java.util.Iterator;
40	import java.util.List;
41	import java.util.Locale;
42	import java.util.Random;
43	import java.util.Set;
44	import java.util.WeakHashMap;
45
46	import javax.swing.JComponent;
47
48	import org.apache.log4j.Logger;
49	import org.geotools.util.WeakHashSet;
50	import org.opengis.util.InternationalString;
51
52	import schmitzm.lang.ResourceProvider;
53	import schmitzm.lang.SortableVector;
54	import skrueger.geotools.Copyable;
55
56	/**
57	* Represents a {@link HashMap} of translations. toString() returns the
58	* appropriate translation. This class is mutable.
59	*
60	* @author <a href="mailto:[email protected]">Stefan Alfons Tzeggai</a>
61	*/
62
63	public class Translation extends HashMap<String, String> implements
64	Copyable<Translation>, Serializable, Cloneable {
65
66	private static final long serialVersionUID = -347702744122305245L;
67
68	public static final String LOCALE_CHANGE_PROPERTY = "localechange";
69	public static final String ACTIVELANG_CHANGE_PROPERTY = "activelangchange";
70	public static final String NO_TRANSLATION = "NO TRANSLATION";
71	public static final String DEFAULT_KEY = "default";
72	static final Logger LOGGER = Logger.getLogger(Translation.class);
73
74	/ A static field defining which language should be served /
75	static String activeLang = Locale.getDefault().getLanguage();
76
77	/**
78	* A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
79	* informed if the acitveLang has been changed with a setActiveLang(..,true
80	* or false).
81	*/
82	static protected WeakHashSet<PropertyChangeListener> listenersActiveLangChange = new WeakHashSet<PropertyChangeListener>(
83	PropertyChangeListener.class);
84
85	/**
86	* A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
87	* informed if the Locale has been changed due to a setActiveLang(..,true)
88	*/
89	static protected WeakHashSet<PropertyChangeListener> listenersLocaleChange = new WeakHashSet<PropertyChangeListener>(
90	PropertyChangeListener.class);
91
92	/**
93	* A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
94	* informed if any of the translations changed. TODO: Should be registerable
95	* for specific languages
96	*/
97	private final WeakHashSet<ActionListener> changeListeners = new WeakHashSet<ActionListener>(
98	ActionListener.class);
99
100	static {
101	// Get default locale
102	Locale locale = Locale.getDefault();
103	setActiveLang(locale.getLanguage());
104	}
105
106	@Override
107	/**
108	* implemented using #toOneLine and #fromOneLine
109	*/
110	public Translation clone() {
111	Translation clone = new Translation();
112	clone.fromOneLine(toOneLine());
113	return clone;
114	}
115
116	/**
117	* Get the two-letter language sting that is active
118	*/
119	public static String getActiveLang() {
120	return activeLang;
121	}
122
123	/**
124	* Set up the {@link Translation}-system to use language. If a change is
125	* performed, events are fired to listeners. Nothing is done if the new
126	* language equals the old language. The system's default {@link Locale} is
127	* changed.
128	*
129	* @param newLang
130	* The ISO Code of the new active language
131	*/
132	public static void setActiveLang(String newLang) {
133	setActiveLang(newLang, true);
134	}
135
136	/**
137	* Set up the {@link Translation}-system to use language. If a change is
138	* performed, events are fired to listeners. Nothing is done if the new
139	* language equals the old language.
140	*
141	* @param newLang
142	* The ISO Code of the new active language
143	*
144	* @param setDefaultLocale
145	* Shall the system's default locale be changed?
146	*/
147	public static void setActiveLang(String newLang, boolean setDefaultLocale) {
148	if (getActiveLang().equals(newLang)) {
149	return;
150	}
151
152	if (!I8NUtil.isValidISOLangCode(newLang)) {
153
154	if (!I8NUtil.isPropertiesLanguage(newLang)) {
155	throw new IllegalArgumentException(
156	"'"
157	+ newLang
158	+ "' is not a valid ISO language code, nor is it a valid userdefined Properties code.");
159	}
160
161	}
162
163	Translation.activeLang = newLang;
164	fireActiveLangChangeEvents();
165
166	Locale newLocale = new Locale(newLang);
167	if (setDefaultLocale) {
168
169	setDefaultLocale(newLocale);
170
171	LOGGER.info(Translation.class.getName()
172	+ " switched ActiveLang and Locale to " + newLang);
173	} else {
174	LOGGER.info(Translation.class.getName()
175	+ " switched ActiveLang to " + newLang);
176	}
177
178	}
179
180	/**
181	* Initializes a new {@link Translation} with a default translation if a
182	* simple text is passed. If a "oneLine" text is parsed, it is interpreted.
183	* Other translations may be added later - this is a HashMap<br/>
184	*
185	* @param defaultTranslation
186	*
187	* @see public Translation(List<String> languages, String
188	* defaultTranslation) {
189	*
190	*/
191	public Translation(String defaultTranslation) {
192
193	fromOneLine(defaultTranslation);
194
195	}
196
197	/**
198	* Initializes a new {@link Translation}, an uses the given String to
199	* initialize the {@link Translation} for all languages codes passed. The
200	* translations can be changed later. This class is not immutable.
201	*
202	* @param languages
203	* if empty or null, the given default {@link Translation} till
204	* be stored under a special key {@link #DEFAULT_KEY}
205	*
206	*
207	*/
208	public Translation(List<String> languages, String defaultTranslation) {
209	if (languages == null \|\| languages.isEmpty()) {
210	put(DEFAULT_KEY, defaultTranslation);
211	} else
212	for (String code : languages) {
213	put(code, defaultTranslation);
214	}
215	}
216
217	/**
218	* Sometimes Translations are optional, like for keywords.
219	*/
220	public Translation() {
221	}
222
223	/**
224	* Fills the {@link Translation} with the values coded into the String
225	* Format of {@link String} is: "de{Baum}en{tree}"
226	* <p>
227	* <ul>
228	* <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
229	* <li>If format can't be recognized, the {@link String} is interpreted as
230	* the translation in the <code>{@value #DEFAULT_KEY}</code> language
231	*
232	* @author Stefan Alfons Tzeggai
233	*/
234	public void fromOneLine(final String oneLineCoded) {
235
236	clear();
237
238	try {
239
240	if ((oneLineCoded == null) \|\| (oneLineCoded.equals(""))) {
241	put(DEFAULT_KEY, "");
242	return;
243	}
244
245	if (oneLineCoded.indexOf("}") == -1) {
246	// log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
247	put(DEFAULT_KEY, oneLineCoded);
248	}
249
250	String eatUp = oneLineCoded;
251	while (eatUp.indexOf("}") != -1) {
252	String substring = eatUp.substring(0, eatUp.indexOf("}"));
253
254	// log.debug("substring = "+substring);
255	String key = substring.substring(0, substring.indexOf("{"));
256	String value = substring.substring(substring.indexOf("{") + 1,
257	substring.length());
258	// log.debug("key="+key);
259	// log.debug("value="+value);
260	put(key, value);
261	eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
262	}
263	} catch (Exception e) {
264	LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded
265	+ "'", e);
266	LOGGER.warn("Translation will be empty!");
267	}
268	}
269
270	/**
271	* Exports the Translations to a String of the Format: "de{Baum}en{tree}"
272	*
273	* @author Stefan Alfons Tzeggai
274	*/
275	public String toOneLine() {
276	return I8NUtil.toOneLine(this);
277	}
278
279	/**
280	* Returns the correct translation by using the {@link #activeLang} field.
281	* If no translation is set, an ugly String {@link #NO_TRANSLATION} will re
282	* returned. This might be changed for the final release. If the correct
283	* language was not found, any entry in the {@link Translation}
284	* {@link HashMap} will be returned, that contains more than an empty
285	* string.
286	*/
287	@Override
288	public String toString() {
289	final String string = get(activeLang);
290	if (string != null) {
291	return get(activeLang);
292	}
293	// ****************************************************************************
294	// MS: The ISDSS needs the concept of the default lang!! So I took the
295	// following in again!!
296	// ****************************************************************************
297	// else return "";
298	// //****************************************************************************
299	// // ST: The following is commented out.. the concept of the default
300	// lang
301	// seems to be bad....
302	// //****************************************************************************
303	// MS:
304	else {
305	if (get(DEFAULT_KEY) != null) {
306	return get(DEFAULT_KEY);
307	}
308
309	// log.debug("return first best <> '' ");
310	if (size() > 0)
311	for (String s : values()) {
312	if ((s != null) && (s.trim().length() > 0))
313	return s;
314	}
315	}
316	// log.warn("No translation found!");
317	return NO_TRANSLATION;
318	}
319
320	/**
321	* {@link PropertyChangeListener} can be registered to be informed when the
322	* {@link Locale} changed.<br>
323	* The listeners are kept in a {@link WeakHashMap}, so you have to keep a
324	* reference to the listener or it will be removed!
325	*
326	* @param propertyChangeListener
327	* A {@link PropertyChangeListener} that will be called when
328	* {@link #setActiveLang(String)} changes the language.
329	*/
330	public static void addLocaleChangeListener(
331	PropertyChangeListener propertyChangeListener) {
332	listenersLocaleChange.add(propertyChangeListener);
333	}
334
335	/**
336	* {@link PropertyChangeListener} can be registered to be informed when the
337	* {@link Locale} changed.<br>
338	* The listeners are kept in a {@link WeakHashMap}, so you have to keep a
339	* reference to the listener or it will be removed!
340	*
341	* @param propertyChangeListener
342	* A {@link PropertyChangeListener} that will be called when
343	* {@link #setActiveLang(String)} changes the language.
344	*/
345	public static boolean removeLocaleChangeListener(
346	PropertyChangeListener propertyChangeListener) {
347	return listenersLocaleChange.remove(propertyChangeListener);
348	}
349
350	/**
351	* {@link PropertyChangeListener} can be registered to be informed when the
352	* {@link Locale} changed.<br>
353	* The listeners are kept in a {@link WeakHashMap}, so you have to keep a
354	* reference to the listener or it will be removed!
355	*
356	* @param propertyChangeListener
357	* A {@link PropertyChangeListener} that will be called when
358	* {@link #setActiveLang(String)} changes the language.
359	*/
360	public static void addActiveLangChangeListener(
361	PropertyChangeListener propertyChangeListener) {
362	listenersActiveLangChange.add(propertyChangeListener);
363	}
364
365	/**
366	* {@link PropertyChangeListener} can be registered to be informed when the
367	* {@link Locale} changed.<br>
368	* The listeners are kept in a {@link WeakHashMap}, so you have to keep a
369	* reference to the listener or it will be removed!
370	*
371	* @param propertyChangeListener
372	* A {@link PropertyChangeListener} that will be called when
373	* {@link #setActiveLang(String)} changes the language.
374	*/
375	public static boolean removeActiveLangListener(
376	PropertyChangeListener propertyChangeListener) {
377	return listenersActiveLangChange.remove(propertyChangeListener);
378	}
379
380	/**
381	* Informs all registered {@link PropertyChangeListener}s about a change of
382	* type LOCALE_CHANGE_PROPERTY the the {@link Locale}.
383	*/
384	public static void fireLocaleChangeEvents() {
385	PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
386	new ArrayList<String>(), "fakeSource"), LOCALE_CHANGE_PROPERTY,
387	null, getActiveLang());
388	for (PropertyChangeListener pcl : listenersLocaleChange) {
389	if (pcl != null)
390	pcl.propertyChange(pce);
391	}
392	}
393
394	/**
395	* Informs all registered {@link PropertyChangeListener}s about a change of
396	* type ACTIVELANG_CHANGE_PROPERTY the the {@link Locale}.
397	*/
398	public static void fireActiveLangChangeEvents() {
399	PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
400	new ArrayList<String>(), "fakeSource"),
401	ACTIVELANG_CHANGE_PROPERTY, null, getActiveLang());
402	for (PropertyChangeListener pcl : listenersActiveLangChange) {
403	if (pcl != null)
404	pcl.propertyChange(pce);
405	}
406	}
407
408	/**
409	* The listeneras are stored in a {@link WeakHashSet}! So you HAVE TO KEEP a
410	* reference as long as you need the listener.
411	*/
412	public void addTranslationChangeListener(ActionListener actionListener) {
413	if (changeListeners.add(actionListener)) {
414	// LOGGER
415	// .debug("registering a new translationChangeActionListener in the WeakHashSet");
416	}
417	}
418
419	/**
420	* The listeneras are stored in a {@link WeakHashSet}! You don't have to
421	* remove the listener, as long as you throw away the reference to the
422	* listener.
423	*/
424	public boolean removeTranslationChangeListener(ActionListener actionListener) {
425	return changeListeners.remove(actionListener);
426	}
427
428	public void fireTranslationChangedEvents(String lang) {
429	ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);
430
431	final Iterator<ActionListener> iterator = changeListeners.iterator();
432	while (iterator.hasNext()) {
433	ActionListener al = iterator.next();
434	al.actionPerformed(ae);
435	}
436	}
437
438	@Override
439	public String put(String lang, String value) {
440	String result = super.put(lang, value);
441	fireTranslationChangedEvents(lang);
442	return result;
443	}
444
445	public void fromOneLine(InternationalString iString) {
446	if (iString != null)
447	fromOneLine(iString.toString());
448	else
449	fromOneLine((String) null);
450	}
451
452	/**
453	* Copy this {@link Translation} to another {@link Translation} e.g. for
454	* editing and return the target.
455	*
456	* @return the destination {@link Translation}
457	*/
458	@Override
459	public Translation copyTo(Translation translation2) {
460	if (translation2 == null)
461	return copy();
462
463	translation2.fromOneLine(toOneLine());
464	return translation2;
465	}
466
467	@Override
468	public Translation copy() {
469	return copyTo(new Translation());
470	}
471
472	/**
473	* Checks if the {@link String}s stored in the {@link Translation} are all
474	* valid.
475	*
476	* @return <code>true</code> if all good
477	*/
478	public static boolean checkValid(Translation translationToCheck) {
479
480	for (String l : translationToCheck.values()) {
481
482	if (l.contains("{") \|\| l.contains("}")) {
483
484	return false;
485	}
486	}
487	return true;
488	}
489
490	/**
491	* Goes through the available languages of the FIRST registered
492	* {@link ResourceProvider} and set the active locale to the fist match.
493	*
494	* @param fireChangeEvent
495	* if <code>true</code>, a Translation.fireLocaleChangeEvents()
496	* is issued.
497	*
498	* @return
499	*/
500	public static boolean setFirstmatchingLanguage(List<String> languages,
501	boolean fireChangeEvent) {
502
503	SortableVector<ResourceProvider> registeredResourceProvider = ResourceProvider
504	.getRegisteredResourceProvider();
505	Set<Locale> available = ResourceProvider.getAvailableLocales(
506	registeredResourceProvider.get(0), true);
507
508	for (String l : languages) {
509	for (Locale loc : available) {
510	if (loc.getLanguage().equals(l)) {
511	Translation.setActiveLang(l);
512	if (fireChangeEvent)
513	Translation.fireLocaleChangeEvents();
514	return true;
515	}
516	}
517	}
518
519	return false;
520
521	}
522
523	/**
524	* Returns the translation in a requested language
525	*/
526	public String toString(String lang) {
527	return get(lang);
528	}
529
530	/**
531	* Will set the default Locale (if not already equal) and fire Locale change
532	* events.
533	*
534	* @param if <code>null</code> will do nothing.
535	*/
536	public static void setDefaultLocale(Locale locale) {
537
538	if (locale == null)
539	return;
540
541	if (I8NUtil.isPropertiesLanguage(locale.getLanguage())) {
542	locale = I8NUtil.propLocales.get(locale.getLanguage())
543	.getParentLocale();
544	}
545
546	if (Locale.getDefault().equals(locale))
547	return;
548	Locale.setDefault(locale);
549	/**
550	* Setting default locale for Swing JComponents to work around bug
551	* http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
552	*/
553	JComponent.setDefaultLocale(locale);
554
555	fireLocaleChangeEvents();
556	}
557
558	}