/[schmitzm]/trunk/src/skrueger/i8n/Translation.java
ViewVC logotype

Diff of /trunk/src/skrueger/i8n/Translation.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 20 by alfonx, Wed Mar 4 17:31:50 2009 UTC revision 300 by alfonx, Sat Aug 15 10:33:43 2009 UTC
# Line 1  Line 1 
1  package skrueger.i8n;  /*******************************************************************************
2  import java.util.HashMap;   * Copyright (c) 2009 Martin O. J. Schmitz.
3  import java.util.List;   *
4  import java.util.Locale;   * This file is part of the SCHMITZM library - a collection of utility
5     * classes based on Java 1.6, focusing (not only) on Java Swing
6  import javax.swing.JColorChooser;   * and the Geotools library.
7  import javax.swing.JComponent;   *
8  import javax.swing.JFileChooser;   * The SCHMITZM project is hosted at:
9  import javax.swing.JOptionPane;   * http://wald.intevation.org/projects/schmitzm/
10     *
11  import org.apache.log4j.Logger;   * 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   * Represents a {@link HashMap} of translations.   * of the License, or (at your option) any later version.
15   * toString() returns the appropriate translation   *
16   *   * This program is distributed in the hope that it will be useful,
17   * @author @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>   * 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  public class Translation extends HashMap<String, String> {   *
21          public static final String NO_TRANSLATION = "NO TRANSLATION";   * You should have received a copy of the GNU Lesser General Public License (license.txt)
22          public static final String DEFAULT_KEY = "default";   * along with this program; if not, write to the Free Software
23          static final Logger log = Logger.getLogger( Translation.class );   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24          static String activeLang = "fr";   * or try this link: http://www.gnu.org/licenses/lgpl.html
25     *
26          static {   * Contributors:
27                     *     Martin O. J. Schmitz - initial API and implementation
28                  //TODO default aus Locale auslesen und mit möglichen vergleichen... mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht   *     Stefan A. Krüger - additional utility classes
29     ******************************************************************************/
30                    // Get default locale  package skrueger.i8n;
31              Locale locale = Locale.getDefault();  
32                  setActiveLang(locale.getLanguage());  import java.awt.event.ActionEvent;
33          }  import java.awt.event.ActionListener;
34            import java.beans.PropertyChangeEvent;
35          @Override  import java.beans.PropertyChangeListener;
36          public Translation clone() {  import java.util.ArrayList;
37                  return (Translation) super.clone();  import java.util.HashMap;
38          }  import java.util.List;
39    import java.util.Locale;
40          /**  import java.util.Random;
41           * Get the two-letter language sting that is active  
42           */  import javax.swing.JComponent;
43          public static String getActiveLang() {  
44                  return activeLang;  import org.apache.log4j.Logger;
45          }  
46    /**
47          /**   * Represents a {@link HashMap} of translations. toString() returns the
48           * Set up the {@link Translation}-system to use language.   * appropriate translation
49           * @param activeLang   *
50           */   * @author @author <a href="mailto:[email protected]">Stefan Alfons
51          public static void setActiveLang(String activeLang) {   *         Kr&uuml;ger</a>
52                  if (!I8NUtil.isValidISOLangCode(activeLang)) {   */
53                          throw new IllegalArgumentException("'"+activeLang+"' is not a valid ISO language code.");  
54                  }  public class Translation extends HashMap<String, String> {
55            public static final String LOCALECHANGE_PROPERTY = "localechange";
56                  Locale newLocale = new Locale(activeLang);          public static final String NO_TRANSLATION = "NO TRANSLATION";
57                  Locale.setDefault(newLocale);          public static final String DEFAULT_KEY = "default";
58                            static final Logger log = Logger.getLogger(Translation.class);
59                  /**          static String activeLang = Locale.getDefault().getLanguage();
60                   * Setting default locale for Swing JComponents to work around bug  
61                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();
62                   */  
63                  JComponent.setDefaultLocale(newLocale);          static {
64                    
65                  Translation.activeLang = activeLang;                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
66                  log.info("Translation-system switched to "+activeLang);                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
67          }  
68                    // Get default locale
69          /**                  Locale locale = Locale.getDefault();
70           * Initilises a new {@link Translation} with a default translation.                  setActiveLang(locale.getLanguage());
71           * Other translations may be added later.          }
72           *  
73           * @param defaultTranslation          private List<ActionListener> actionListeners = new ArrayList<ActionListener>();
74           *  
75           * @deprecated SK: The concept of the default translation doesn't seem so nice to me anymore..          @Override
76           * I would prefer the default translation to be set for all valid languages.          /*
77           *           * @comment To make a copy of a translation see methods toOneLine() and
78           * @see public Translation(List<String> languages, String defaultTranslation) {           * fromOneLine()
79           *           */
80           */          public Translation clone() {
81          public Translation(String defaultTranslation) {                  return (Translation) super.clone();
82                  put(DEFAULT_KEY, defaultTranslation);          }
83          }  
84            /**
85          /**           * Get the two-letter language sting that is active
86           * Initilises a new {@link Translation}, an uses the given String to           */
87           * initialise the {@link Translation} for all languages codes passed.          public static String getActiveLang() {
88           *                  return activeLang;
89           * The translations can be cahnged later          }
90           */  
91          public Translation(List<String> languages, String defaultTranslation) {          /**
92                  // put(DEFAULT_KEY, defaultTranslation);           * Set up the {@link Translation}-system to use language. If a change is
93                  if (languages == null) {           * performed, events are fired to listeners. Nothing is done if the new
94                          put(DEFAULT_KEY, defaultTranslation);           * language equals the old language. The system's default locale is changed.
95                  }           *
96                  else for (String code : languages){           * @param newLang
97                          put(code, defaultTranslation);           *            The ISO Code of the new active language
98                  }           */
99          }          public static void setActiveLang(String newLang) {
100                    setActiveLang(newLang, true);
101          /**          }
102           * Sometimes Translations are optional, like for keywords.  
103           */          /**
104          public Translation() {           * Set up the {@link Translation}-system to use language. If a change is
105                  super();           * performed, events are fired to listeners. Nothing is done if the new
106          }           * language equals the old language.
107             *
108          /**           * @param newLang
109           * Fills the {@link Translation} with the values coded into the String           *            The ISO Code of the new active language
110           * Format of {@link String} is: "de{Baum}en{tree}"           *
111           * <p>           * @param setDefaultLocale
112           * <ul>           *            Shall the system's default locale be changed?
113           * <li> If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.           */
114           * <li> If format can't be recognized, the {@link String} is interpreted as the translation in the <code>{@value #DEFAULT_KEY}</code> language          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
115           *                  if (getActiveLang().equals(newLang)) {
116           * @author Stefan Alfons Krüger                          return;
117           */                  }
118          public void fromOneLine( final String oneLineCoded) {  
119                  clear();                  if (!I8NUtil.isValidISOLangCode(newLang)) {
120                  if ( (oneLineCoded == null) || (oneLineCoded.equals("")) ) {                          throw new IllegalArgumentException("'" + newLang
121                          put(DEFAULT_KEY,NO_TRANSLATION);                                          + "' is not a valid ISO language code.");
122                          return;                  }
123                  }  
124                    Locale newLocale = new Locale(newLang);
125                  if (oneLineCoded.indexOf("}") == -1) {                  if (setDefaultLocale)
126                  //      log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");                          Locale.setDefault(newLocale);
127                          put(DEFAULT_KEY,oneLineCoded);  
128                  }                  /**
129                     * Setting default locale for Swing JComponents to work around bug
130                  String eatUp = oneLineCoded;                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
131                  while ( eatUp.indexOf("}") != -1) {                   */
132                          String substring = eatUp.substring(0, eatUp.indexOf("}"));                  JComponent.setDefaultLocale(newLocale);
133    
134  //                      log.debug("substring = "+substring);                  Translation.activeLang = newLang;
135                          String key   = substring.substring(0, substring.indexOf("{") );  
136                          String value = substring.substring(substring.indexOf("{")+1, substring.length() );                  fireLocaleChangeEvents();
137  //                      log.debug("key="+key);  
138  //                      log.debug("value="+value);                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
139                          put(key,value);          }
140                          eatUp = eatUp.substring(eatUp.indexOf("}")+1);  
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           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"           *
146           * @author Stefan Alfons Krüger           * @param defaultTranslation
147           */           *
148          public String toOneLine(){           * @see public Translation(List<String> languages, String
149                  StringBuffer oneLine = new StringBuffer();           *      defaultTranslation) {
150                  for (String key: keySet()) {           *
151                          oneLine.append(key+"{"+ get(key) + "}");           */
152                  }          public Translation(String defaultTranslation) {
153                  return oneLine.toString();  
154          }                  fromOneLine(defaultTranslation);
155    
156          /**          }
157           * Returns the right translation by using the {@link #activeLang} field.  
158           * If no translation is set, an ugly String {@link #NO_TRANSLATION} will re returned. This might be changed for the final release.          /**
159           * If the correct language was not found, any entry in the {@link Translation} {@link HashMap} will be returned, that contains           * Initializes a new {@link Translation}, an uses the given String to
160           *  more than an empty string.           * initialize the {@link Translation} for all languages codes passed.
161           */           *
162          @Override           * The translations can be changed later
163          public String toString(){           */
164                  if ( get(activeLang) != null ) {          public Translation(List<String> languages, String defaultTranslation) {
165                          return get(activeLang);                  // put(DEFAULT_KEY, defaultTranslation);
166                  }                  if (languages == null) {
167                  //****************************************************************************                          put(DEFAULT_KEY, defaultTranslation);
168                  // MS: The ISDSS needs the concept of the default lang!! So I took the                  } else
169                  //     following in again!!                          for (String code : languages) {
170                  //****************************************************************************                                  if (code.equals(getActiveLang())) {
171  //              else return "";                                          put(code, defaultTranslation);
172  //              //****************************************************************************                                  }
173  //              // The following is commented out.. the concept of the default lang seems to be bad....                          }
174  //              //****************************************************************************          }
175                  // MS:  
176                  else {          /**
177                          if ( get(DEFAULT_KEY) != null ) {           * Sometimes Translations are optional, like for keywords.
178  //                              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.");           */
179                                  return get(DEFAULT_KEY);          public Translation() {
180                          }          }
181    
182                          // log.debug("return first best <> '' ");          /**
183                          if (size() > 0)           * Fills the {@link Translation} with the values coded into the String
184                                  for ( String s : values() ) {           * Format of {@link String} is: "de{Baum}en{tree}"
185                                          if ( (s != null) && (s.trim().length()>0) )           * <p>
186                                                  return s;           * <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                  log.warn("No translation found!");           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
190                  return NO_TRANSLATION;           *
191          }           * @author Stefan Alfons Krüger
192             */
193          /**          public void fromOneLine(final String oneLineCoded) {
194           * Copy this {@link Translation} to another {@link Translation}                  clear();
195           * e.g. for editing                  if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
196           *                          put(DEFAULT_KEY, "");
197           * @return the destination {@link Translation}                          return;
198           */                  }
199          public Translation copy(Translation backup) {  
200                  if (backup == null) throw new IllegalArgumentException("Target translation may not be null.");                  if (oneLineCoded.indexOf("}") == -1) {
201                  for (String s : keySet() ) {                          // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
202                          backup.put(s, get(s) );                          put(DEFAULT_KEY, oneLineCoded);
203                  }                  }
204                  return backup;  
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            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(String lang) {
319                    ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);
320                    
321                    for (ActionListener al : actionListeners) {
322                            al.actionPerformed( ae);
323                    }
324            }
325            
326            @Override
327            public String put(String lang, String value) {
328                    String result = super.put(lang, value);
329                    fireTranslationChangedEvents(lang);
330                    return result;
331            }
332            
333            
334    }
Legend:
Removed from v.20  
changed lines
  Added in v.300
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26