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 LOCALECHANGE_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 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)) {
                        throw new IllegalArgumentException("'" + newLang
                                        + "' is not a valid ISO language code.");
                }

                Translation.activeLang = newLang;
                fireActiveLangChangeEvents();

                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);

                        fireLocaleChangeEvents();

                        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
         * 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 : listenersLocaleChange) {
                        if (pcl != null)
                                pcl.propertyChange(pce);
                }
        }

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