skrueger/i8n/Translation.java

package skrueger.i8n;

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 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 = "fr";

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

        @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.
         * 
         * @param newLang
         *            The ISO Code of the new active language
         */
        public static void setActiveLang(String newLang) {
                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);
                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;

                fireChangeEvents();

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

        /**
         * Initializes a new {@link Translation} with a default translation. Other
         * translations may be added later.
         * 
         * @param defaultTranslation
         * 
         * @deprecated SK: The concept of the default translation doesn't seem so
         *             nice to me anymore.. I would prefer the default translation
         *             to be set for all valid languages.
         * 
         * @see public Translation(List<String> languages, String
         *      defaultTranslation) {
         * 
         */
        public Translation(String defaultTranslation) {
                put(DEFAULT_KEY, 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() {
                super();
        }

        /**
         * 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, NO_TRANSLATION);
                        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() {
                StringBuffer oneLine = new StringBuffer();
                for (String key : keySet()) {
                        oneLine.append(key + "{" + get(key) + "}");
                }
                return oneLine.toString();
        }

        /**
         * 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 lng 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 fireChangeEvents() {
                PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
                                new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,
                                null, getActiveLang());
                for (PropertyChangeListener pcl : listeners) {
                        if (pcl != null)
                                pcl.propertyChange(pce);
                }
        }


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