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