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

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