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.List;
import java.util.Locale;
import java.util.Random;

import javax.swing.JComponent;

import org.apache.log4j.Logger;

/**
 * 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> {
        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 List<ActionListener> actionListeners = new ArrayList<ActionListener>();

        @Override
        /*
         * @comment To make a copy of a translation see methods toOneLine() and
         * fromOneLine()
         */
        public Translation clone() {
                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();
                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);
                }
        }

        /**
         * 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) {
                                // log.debug("default lang returned, cuz the translation to "+activeLang+" was not found. Schmeiss raus martin, wenn du das mit der default trans geklärt hast.");
                                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;
        }

        /**
         * Copy this {@link Translation} to another {@link Translation} e.g. for
         * editing
         * 
         * @return the destination {@link Translation}
         */
        public Translation copy(Translation backup) {
                if (backup == null)
                        throw new IllegalArgumentException(
                                        "Target translation may not be null.");
                for (String s : keySet()) {
                        backup.put(s, get(s));
                }
                return backup;
        }

        /**
         * {@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);
                }
        }

        public void addTranslationChangeListener(ActionListener actionListener) {
                actionListeners.add(actionListener);
        }
        
        public boolean removeTranslationChangeListener(ActionListener actionListener) {
                return actionListeners.remove(actionListener);
        }

        public void fireTranslationChangedEvents() {
                ActionEvent ae = new ActionEvent(this, new Random().nextInt(),  "");
                
                for (ActionListener al : actionListeners) {
                        al.actionPerformed( ae);
                }
        }
        
        @Override
        public String put(String key, String value) {
                String result = super.put(key, value);
                fireTranslationChangedEvents();
                return result;
        }
        
        
}
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			* Stefan A. Krüger - additional utility classes
29			******************************************************************************/
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			import java.util.ArrayList;
37			import java.util.HashMap;
38			import java.util.List;
39			import java.util.Locale;
40	alfonx	292	import java.util.Random;
41	alfonx	244
42			import javax.swing.JComponent;
43
44			import org.apache.log4j.Logger;
45
46			/**
47			* Represents a {@link HashMap} of translations. toString() returns the
48			* appropriate translation
49			*
50			* @author @author <a href="mailto:[email protected]">Stefan Alfons
51			* Krüger</a>
52			*/
53
54			public class Translation extends HashMap<String, String> {
55			public static final String LOCALECHANGE_PROPERTY = "localechange";
56			public static final String NO_TRANSLATION = "NO TRANSLATION";
57			public static final String DEFAULT_KEY = "default";
58			static final Logger log = Logger.getLogger(Translation.class);
59	alfonx	268	static String activeLang = Locale.getDefault().getLanguage();
60	alfonx	244
61			static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();
62
63			static {
64
65			// TODO default aus Locale auslesen und mit möglichen vergleichen...
66			// mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
67
68			// Get default locale
69			Locale locale = Locale.getDefault();
70			setActiveLang(locale.getLanguage());
71			}
72
73	alfonx	292	private List<ActionListener> actionListeners = new ArrayList<ActionListener>();
74
75	alfonx	244	@Override
76			/*
77			* @comment To make a copy of a translation see methods toOneLine() and
78			* fromOneLine()
79			*/
80			public Translation clone() {
81			return (Translation) super.clone();
82			}
83
84			/**
85			* Get the two-letter language sting that is active
86			*/
87			public static String getActiveLang() {
88			return activeLang;
89			}
90
91			/**
92			* Set up the {@link Translation}-system to use language. If a change is
93			* performed, events are fired to listeners. Nothing is done if the new
94			* language equals the old language. The system's default locale is changed.
95			*
96			* @param newLang
97			* The ISO Code of the new active language
98			*/
99			public static void setActiveLang(String newLang) {
100			setActiveLang(newLang, true);
101			}
102
103			/**
104			* Set up the {@link Translation}-system to use language. If a change is
105			* performed, events are fired to listeners. Nothing is done if the new
106			* language equals the old language.
107			*
108			* @param newLang
109			* The ISO Code of the new active language
110			*
111			* @param setDefaultLocale
112			* Shall the system's default locale be changed?
113			*/
114			public static void setActiveLang(String newLang, boolean setDefaultLocale) {
115			if (getActiveLang().equals(newLang)) {
116			return;
117			}
118
119			if (!I8NUtil.isValidISOLangCode(newLang)) {
120			throw new IllegalArgumentException("'" + newLang
121			+ "' is not a valid ISO language code.");
122			}
123
124			Locale newLocale = new Locale(newLang);
125			if (setDefaultLocale)
126			Locale.setDefault(newLocale);
127
128			/**
129			* Setting default locale for Swing JComponents to work around bug
130			* http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
131			*/
132			JComponent.setDefaultLocale(newLocale);
133
134			Translation.activeLang = newLang;
135
136			fireLocaleChangeEvents();
137
138			log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
139			}
140
141			/**
142			* Initializes a new {@link Translation} with a default translation if a
143			* simple text is passed. If a "oneLine" text is parsed, it is interpreted.
144			* Other translations may be added later - this is a HashMap<br/>
145			*
146			* @param defaultTranslation
147			*
148			* @see public Translation(List<String> languages, String
149			* defaultTranslation) {
150			*
151			*/
152			public Translation(String defaultTranslation) {
153
154			fromOneLine(defaultTranslation);
155
156			}
157
158			/**
159			* Initializes a new {@link Translation}, an uses the given String to
160			* initialize the {@link Translation} for all languages codes passed.
161			*
162			* The translations can be changed later
163			*/
164			public Translation(List<String> languages, String defaultTranslation) {
165			// put(DEFAULT_KEY, defaultTranslation);
166			if (languages == null) {
167			put(DEFAULT_KEY, defaultTranslation);
168			} else
169			for (String code : languages) {
170			if (code.equals(getActiveLang())) {
171			put(code, defaultTranslation);
172			}
173			}
174			}
175
176			/**
177			* Sometimes Translations are optional, like for keywords.
178			*/
179			public Translation() {
180			}
181
182			/**
183			* Fills the {@link Translation} with the values coded into the String
184			* Format of {@link String} is: "de{Baum}en{tree}"
185			* <p>
186			* <ul>
187			* <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
188			* <li>If format can't be recognized, the {@link String} is interpreted as
189			* the translation in the <code>{@value #DEFAULT_KEY}</code> language
190			*
191			* @author Stefan Alfons Krüger
192			*/
193			public void fromOneLine(final String oneLineCoded) {
194			clear();
195			if ((oneLineCoded == null) \|\| (oneLineCoded.equals(""))) {
196			put(DEFAULT_KEY, "");
197			return;
198			}
199
200			if (oneLineCoded.indexOf("}") == -1) {
201			// log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
202			put(DEFAULT_KEY, oneLineCoded);
203			}
204
205			String eatUp = oneLineCoded;
206			while (eatUp.indexOf("}") != -1) {
207			String substring = eatUp.substring(0, eatUp.indexOf("}"));
208
209			// log.debug("substring = "+substring);
210			String key = substring.substring(0, substring.indexOf("{"));
211			String value = substring.substring(substring.indexOf("{") + 1,
212			substring.length());
213			// log.debug("key="+key);
214			// log.debug("value="+value);
215			put(key, value);
216			eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
217			}
218			}
219
220			/**
221			* Exports the Translations to a String of the Format: "de{Baum}en{tree}"
222			*
223			* @author Stefan Alfons Krüger
224			*/
225			public String toOneLine() {
226			return I8NUtil.toOneLine(this);
227			}
228
229			/**
230			* Returns the right translation by using the {@link #activeLang} field. If
231			* no translation is set, an ugly String {@link #NO_TRANSLATION} will re
232			* returned. This might be changed for the final release. If the correct
233			* language was not found, any entry in the {@link Translation}
234			* {@link HashMap} will be returned, that contains more than an empty
235			* string.
236			*/
237			@Override
238			public String toString() {
239			if (get(activeLang) != null) {
240			return get(activeLang);
241			}
242			// ****************************************************************************
243			// MS: The ISDSS needs the concept of the default lang!! So I took the
244			// following in again!!
245			// ****************************************************************************
246			// else return "";
247			// //****************************************************************************
248			// // The following is commented out.. the concept of the default lang
249			// seems to be bad....
250			// //****************************************************************************
251			// MS:
252			else {
253			if (get(DEFAULT_KEY) != null) {
254			// log.debug("default lang returned, cuz the translation to "+activeLang+" was not found. Schmeiss raus martin, wenn du das mit der default trans geklärt hast.");
255			return get(DEFAULT_KEY);
256			}
257
258			// log.debug("return first best <> '' ");
259			if (size() > 0)
260			for (String s : values()) {
261			if ((s != null) && (s.trim().length() > 0))
262			return s;
263			}
264			}
265			// log.warn("No translation found!");
266			return NO_TRANSLATION;
267			}
268
269			/**
270			* Copy this {@link Translation} to another {@link Translation} e.g. for
271			* editing
272			*
273			* @return the destination {@link Translation}
274			*/
275			public Translation copy(Translation backup) {
276			if (backup == null)
277			throw new IllegalArgumentException(
278			"Target translation may not be null.");
279			for (String s : keySet()) {
280			backup.put(s, get(s));
281			}
282			return backup;
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	alfonx	292	public void addTranslationChangeListener(ActionListener actionListener) {
311			actionListeners.add(actionListener);
312			}
313
314			public boolean removeTranslationChangeListener(ActionListener actionListener) {
315			return actionListeners.remove(actionListener);
316			}
317
318			public void fireTranslationChangedEvents() {
319			ActionEvent ae = new ActionEvent(this, new Random().nextInt(), "");
320
321			for (ActionListener al : actionListeners) {
322			al.actionPerformed( ae);
323			}
324			}
325
326			@Override
327			public String put(String key, String value) {
328			String result = super.put(key, value);
329			fireTranslationChangedEvents();
330			return result;
331			}
332
333
334	alfonx	244	}