/[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

trunk/src/skrueger/i8n/Translation.java revision 34 by alfonx, Sat Mar 28 18:08:42 2009 UTC branches/2.0-RC1/src/skrueger/i8n/Translation.java revision 607 by alfonx, Wed Dec 9 15:13:42 2009 UTC
# Line 1  Line 1 
1  package skrueger.i8n;  /*******************************************************************************
2  import java.beans.PropertyChangeEvent;   * Copyright (c) 2009 Martin O. J. Schmitz.
3  import java.beans.PropertyChangeListener;   *
4  import java.util.ArrayList;   * This file is part of the SCHMITZM library - a collection of utility
5  import java.util.HashMap;   * classes based on Java 1.6, focusing (not only) on Java Swing
6  import java.util.List;   * and the Geotools library.
7  import java.util.Locale;   *
8     * The SCHMITZM project is hosted at:
9  import javax.swing.JComponent;   * 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 LOCALECHANGE_PROPERTY = "localechange";   * You should have received a copy of the GNU Lesser General Public License (license.txt)
22          public static final String NO_TRANSLATION = "NO TRANSLATION";   * along with this program; if not, write to the Free Software
23          public static final String DEFAULT_KEY = "default";   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24          static final Logger log = Logger.getLogger( Translation.class );   * or try this link: http://www.gnu.org/licenses/lgpl.html
25          static String activeLang = "fr";   *
26     * Contributors:
27          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();   *     Martin O. J. Schmitz - initial API and implementation
28             *     Stefan A. Krüger - additional utility classes
29          static {   ******************************************************************************/
30                    package skrueger.i8n;
31                  //TODO default aus Locale auslesen und mit möglichen vergleichen... mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht  
32    import java.awt.event.ActionEvent;
33                    // Get default locale  import java.awt.event.ActionListener;
34              Locale locale = Locale.getDefault();  import java.beans.PropertyChangeEvent;
35                  setActiveLang(locale.getLanguage());  import java.beans.PropertyChangeListener;
36          }  import java.util.ArrayList;
37            import java.util.HashMap;
38          @Override  import java.util.Iterator;
39          /**  import java.util.List;
40           * @comment To make a copy of a translation see methods toOneLine() and fromOneLine()  import java.util.Locale;
41           */  import java.util.Random;
42          public Translation clone() {  import java.util.WeakHashMap;
43                  return (Translation) super.clone();  
44          }  import javax.swing.JComponent;
45    
46          /**  import org.apache.log4j.Logger;
47           * Get the two-letter language sting that is active  import org.geotools.util.WeakHashSet;
48           */  import org.opengis.util.InternationalString;
49          public static String getActiveLang() {  
50                  return activeLang;  import skrueger.geotools.Copyable;
51          }  
52    /**
53          /**   * Represents a {@link HashMap} of translations. toString() returns the
54           * Set up the {@link Translation}-system to use language.   * appropriate translation
55           * @param activeLang   *
56           */   * @author @author <a href="mailto:[email protected]">Stefan Alfons
57          public static void setActiveLang(String activeLang) {   *         Kr&uuml;ger</a>
58                  if (!I8NUtil.isValidISOLangCode(activeLang)) {   */
59                          throw new IllegalArgumentException("'"+activeLang+"' is not a valid ISO language code.");  
60                  }  public class Translation extends HashMap<String, String> implements
61                    Copyable<Translation> {
62                  Locale newLocale = new Locale(activeLang);          public static final String LOCALECHANGE_PROPERTY = "localechange";
63                  Locale.setDefault(newLocale);          public static final String NO_TRANSLATION = "NO TRANSLATION";
64                            public static final String DEFAULT_KEY = "default";
65                  /**          static final Logger LOGGER = Logger.getLogger(Translation.class);
66                   * Setting default locale for Swing JComponents to work around bug          static String activeLang = Locale.getDefault().getLanguage();
67                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480  
68                   */          static protected WeakHashSet<PropertyChangeListener> listeners = new WeakHashSet<PropertyChangeListener>(
69                  JComponent.setDefaultLocale(newLocale);                          PropertyChangeListener.class);
70                    
71                  Translation.activeLang = activeLang;          static {
72                    
73                  fireChangeEvents();                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
74                                    // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
75                  log.info("skrueger.i8n.Translation switched ActiveLang to "+activeLang);  
76          }                  // Get default locale
77                    Locale locale = Locale.getDefault();
78          /**                  setActiveLang(locale.getLanguage());
79           * Initializes a new {@link Translation} with a default translation.          }
80           * Other translations may be added later.  
81           *          private WeakHashSet<ActionListener> actionListeners = new WeakHashSet<ActionListener>(
82           * @param defaultTranslation                          ActionListener.class);
83           *  
84           * @deprecated SK: The concept of the default translation doesn't seem so nice to me anymore..          @Override
85           * I would prefer the default translation to be set for all valid languages.          /*
86           *           * @comment To make a copy of a translation see methods toOneLine() and
87           * @see public Translation(List<String> languages, String defaultTranslation) {           * fromOneLine()
88           *           */
89           */          public Translation clone() {
90          public Translation(String defaultTranslation) {                  throw new RuntimeException("use copy()");
91                  put(DEFAULT_KEY, defaultTranslation);                  // return (Translation) super.clone();
92          }          }
93    
94          /**          /**
95           * Initializes a new {@link Translation}, an uses the given String to           * Get the two-letter language sting that is active
96           * initialize the {@link Translation} for all languages codes passed.           */
97           *          public static String getActiveLang() {
98           * The translations can be changed later                  return activeLang;
99           */          }
100          public Translation(List<String> languages, String defaultTranslation) {  
101                  // put(DEFAULT_KEY, defaultTranslation);          /**
102                  if (languages == null) {           * Set up the {@link Translation}-system to use language. If a change is
103                          put(DEFAULT_KEY, defaultTranslation);           * performed, events are fired to listeners. Nothing is done if the new
104                  }           * language equals the old language. The system's default locale is changed.
105                  else for (String code : languages){           *
106                          put(code, defaultTranslation);           * @param newLang
107                  }           *            The ISO Code of the new active language
108          }           */
109            public static void setActiveLang(String newLang) {
110          /**                  setActiveLang(newLang, true);
111           * Sometimes Translations are optional, like for keywords.          }
112           */  
113          public Translation() {          /**
114                  super();           * Set up the {@link Translation}-system to use language. If a change is
115          }           * performed, events are fired to listeners. Nothing is done if the new
116             * language equals the old language.
117          /**           *
118           * Fills the {@link Translation} with the values coded into the String           * @param newLang
119           * Format of {@link String} is: "de{Baum}en{tree}"           *            The ISO Code of the new active language
120           * <p>           *
121           * <ul>           * @param setDefaultLocale
122           * <li> If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.           *            Shall the system's default locale be changed?
123           * <li> If format can't be recognized, the {@link String} is interpreted as the translation in the <code>{@value #DEFAULT_KEY}</code> language           */
124           *          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
125           * @author Stefan Alfons Krüger                  if (getActiveLang().equals(newLang)) {
126           */                          return;
127          public void fromOneLine( final String oneLineCoded) {                  }
128                  clear();  
129                  if ( (oneLineCoded == null) || (oneLineCoded.equals("")) ) {                  if (!I8NUtil.isValidISOLangCode(newLang)) {
130                          put(DEFAULT_KEY,NO_TRANSLATION);                          throw new IllegalArgumentException("'" + newLang
131                          return;                                          + "' is not a valid ISO language code.");
132                  }                  }
133    
134                  if (oneLineCoded.indexOf("}") == -1) {                  Locale newLocale = new Locale(newLang);
135                  //      log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");                  if (setDefaultLocale)
136                          put(DEFAULT_KEY,oneLineCoded);                          Locale.setDefault(newLocale);
137                  }  
138                    /**
139                  String eatUp = oneLineCoded;                   * Setting default locale for Swing JComponents to work around bug
140                  while ( eatUp.indexOf("}") != -1) {                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
141                          String substring = eatUp.substring(0, eatUp.indexOf("}"));                   */
142                    JComponent.setDefaultLocale(newLocale);
143  //                      log.debug("substring = "+substring);  
144                          String key   = substring.substring(0, substring.indexOf("{") );                  Translation.activeLang = newLang;
145                          String value = substring.substring(substring.indexOf("{")+1, substring.length() );  
146  //                      log.debug("key="+key);                  fireLocaleChangeEvents();
147  //                      log.debug("value="+value);  
148                          put(key,value);                  LOGGER.info("skrueger.i8n.Translation switched ActiveLang to "
149                          eatUp = eatUp.substring(eatUp.indexOf("}")+1);                                  + newLang);
150                  }          }
151          }  
152            /**
153          /**           * Initializes a new {@link Translation} with a default translation if a
154           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
155           * @author Stefan Alfons Krüger           * Other translations may be added later - this is a HashMap<br/>
156           */           *
157          public String toOneLine(){           * @param defaultTranslation
158                  StringBuffer oneLine = new StringBuffer();           *
159                  for (String key: keySet()) {           * @see public Translation(List<String> languages, String
160                          oneLine.append(key+"{"+ get(key) + "}");           *      defaultTranslation) {
161                  }           *
162                  return oneLine.toString();           */
163          }          public Translation(String defaultTranslation) {
164    
165          /**                  fromOneLine(defaultTranslation);
166           * Returns the right translation by using the {@link #activeLang} field.  
167           * If no translation is set, an ugly String {@link #NO_TRANSLATION} will re returned. This might be changed for the final release.          }
168           * If the correct language was not found, any entry in the {@link Translation} {@link HashMap} will be returned, that contains  
169           *  more than an empty string.          /**
170           */           * Initializes a new {@link Translation}, an uses the given String to
171          @Override           * initialize the {@link Translation} for all languages codes passed.
172          public String toString(){           *
173                  if ( get(activeLang) != null ) {           * The translations can be changed later
174                          return get(activeLang);           */
175                  }          public Translation(List<String> languages, String defaultTranslation) {
176                  //****************************************************************************                  // put(DEFAULT_KEY, defaultTranslation);
177                  // MS: The ISDSS needs the concept of the default lang!! So I took the                  if (languages == null) {
178                  //     following in again!!                          put(DEFAULT_KEY, defaultTranslation);
179                  //****************************************************************************                  } else
180  //              else return "";                          for (String code : languages) {
181  //              //****************************************************************************                                  if (code.equals(getActiveLang())) {
182  //              // The following is commented out.. the concept of the default lang seems to be bad....                                          put(code, defaultTranslation);
183  //              //****************************************************************************                                  }
184                  // MS:                          }
185                  else {          }
186                          if ( get(DEFAULT_KEY) != null ) {  
187  //                              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.");          /**
188                                  return get(DEFAULT_KEY);           * Sometimes Translations are optional, like for keywords.
189                          }           */
190            public Translation() {
191                          // log.debug("return first best <> '' ");          }
192                          if (size() > 0)  
193                                  for ( String s : values() ) {          /**
194                                          if ( (s != null) && (s.trim().length()>0) )           * Fills the {@link Translation} with the values coded into the String
195                                                  return s;           * Format of {@link String} is: "de{Baum}en{tree}"
196                                  }           * <p>
197                  }           * <ul>
198                  log.warn("No translation found!");           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
199                  return NO_TRANSLATION;           * <li>If format can't be recognized, the {@link String} is interpreted as
200          }           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
201             *
202          /**           * @author Stefan Alfons Krüger
203           * Copy this {@link Translation} to another {@link Translation}           */
204           * e.g. for editing          public void fromOneLine(final String oneLineCoded) {
205           *  
206           * @return the destination {@link Translation}                  clear();
207           */  
208          public Translation copy(Translation backup) {                  try {
209                  if (backup == null) throw new IllegalArgumentException("Target translation may not be null.");  
210                  for (String s : keySet() ) {                          if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
211                          backup.put(s, get(s) );                                  put(DEFAULT_KEY, "");
212                  }                                  return;
213                  return backup;                          }
214          }  
215                                    if (oneLineCoded.indexOf("}") == -1) {
216                                            // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
217          /**                                  put(DEFAULT_KEY, oneLineCoded);
218           * {@link PropertyChangeListener} can be registered to be informed when the                          }
219           * {@link Locale} changed.  
220           *                          String eatUp = oneLineCoded;
221           * @param propertyChangeListener                          while (eatUp.indexOf("}") != -1) {
222           */                                  String substring = eatUp.substring(0, eatUp.indexOf("}"));
223          public static void addLocaleChangeListener(PropertyChangeListener propertyChangeListener) {  
224                  listeners.add(propertyChangeListener);                                  // log.debug("substring = "+substring);
225          }                                  String key = substring.substring(0, substring.indexOf("{"));
226                                    String value = substring.substring(substring.indexOf("{") + 1,
227          /**                                                  substring.length());
228           * Informs all registered {@link PropertyChangeListener}s about a change of the                                  // log.debug("key="+key);
229           * the {@link Locale}.                                    // log.debug("value="+value);
230           */                                  put(key, value);
231          public static void fireChangeEvents() {                                  eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
232                  PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,                          }
233                                  null, getActiveLang());                  } catch (Exception e) {
234                  for (PropertyChangeListener pcl : listeners) {                          LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded
235                          if (pcl != null)                                          + "'", e);
236                                  pcl.propertyChange(pce);                          LOGGER.warn("Translation will be empty!");
237                  }                  }
238          }          }
239    
240            /**
241  }           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
242             *
243             * @author Stefan Alfons Krüger
244             */
245            public String toOneLine() {
246                    return I8NUtil.toOneLine(this);
247            }
248    
249            /**
250             * Returns the right translation by using the {@link #activeLang} field. If
251             * no translation is set, an ugly String {@link #NO_TRANSLATION} will re
252             * returned. This might be changed for the final release. If the correct
253             * language was not found, any entry in the {@link Translation}
254             * {@link HashMap} will be returned, that contains more than an empty
255             * string.
256             */
257            @Override
258            public String toString() {
259                    if (get(activeLang) != null) {
260                            return get(activeLang);
261                    }
262                    // ****************************************************************************
263                    // MS: The ISDSS needs the concept of the default lang!! So I took the
264                    // following in again!!
265                    // ****************************************************************************
266                    // else return "";
267                    // //****************************************************************************
268                    // // The following is commented out.. the concept of the default lang
269                    // seems to be bad....
270                    // //****************************************************************************
271                    // MS:
272                    else {
273                            if (get(DEFAULT_KEY) != null) {
274                                    return get(DEFAULT_KEY);
275                            }
276    
277                            // log.debug("return first best <> '' ");
278                            if (size() > 0)
279                                    for (String s : values()) {
280                                            if ((s != null) && (s.trim().length() > 0))
281                                                    return s;
282                                    }
283                    }
284                    // log.warn("No translation found!");
285                    return NO_TRANSLATION;
286            }
287    
288            /**
289             * {@link PropertyChangeListener} can be registered to be informed when the
290             * {@link Locale} changed.<br>
291             * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
292             * reference to the listener or it will be removed!
293             *
294             * @param propertyChangeListener
295             *            A {@link PropertyChangeListener} that will be called when
296             *            {@link #setActiveLang(String)} changes the language.
297             */
298            public static void addLocaleChangeListener(
299                            PropertyChangeListener propertyChangeListener) {
300                    listeners.add(propertyChangeListener);
301            }
302    
303            /**
304             * {@link PropertyChangeListener} can be registered to be informed when the
305             * {@link Locale} changed.<br>
306             * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
307             * reference to the listener or it will be removed!
308             *
309             * @param propertyChangeListener
310             *            A {@link PropertyChangeListener} that will be called when
311             *            {@link #setActiveLang(String)} changes the language.
312             */
313            public static boolean removeLocaleChangeListener(
314                            PropertyChangeListener propertyChangeListener) {
315                    return listeners.remove(propertyChangeListener);
316            }
317    
318            /**
319             * Informs all registered {@link PropertyChangeListener}s about a change of
320             * the the {@link Locale}.
321             */
322            public static void fireLocaleChangeEvents() {
323                    PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
324                                    new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,
325                                    null, getActiveLang());
326                    for (PropertyChangeListener pcl : listeners) {
327                            if (pcl != null)
328                                    pcl.propertyChange(pce);
329                    }
330            }
331    
332            /**
333             * The listeneras are stored in a {@link WeakHashSet}! So you HAVE TO KEEP a
334             * reference as long as you need the listener.
335             */
336            public void addTranslationChangeListener(ActionListener actionListener) {
337                    if (actionListeners.add(actionListener)) {
338                            LOGGER
339                                            .debug("registering a new translationChangeActionListener in the WeakHashSet");
340                    }
341            }
342    
343            /**
344             * The listeneras are stored in a {@link WeakHashSet}! You don't have to
345             * remove the listener, as long as you throw away the reference to the
346             * listener.
347             */
348            public boolean removeTranslationChangeListener(ActionListener actionListener) {
349                    return actionListeners.remove(actionListener);
350            }
351    
352            public void fireTranslationChangedEvents(String lang) {
353                    ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);
354    
355                    final Iterator<ActionListener> iterator = actionListeners.iterator();
356                    while (iterator.hasNext()) {
357                            ActionListener al = iterator.next();
358                            al.actionPerformed(ae);
359                    }
360            }
361    
362            @Override
363            public String put(String lang, String value) {
364                    String result = super.put(lang, value);
365                    fireTranslationChangedEvents(lang);
366                    return result;
367            }
368    
369            public void fromOneLine(InternationalString iString) {
370                    if (iString != null)
371                            fromOneLine(iString.toString());
372                    else
373                            fromOneLine((String) null);
374            }
375    
376            /**
377             * Copy this {@link Translation} to another {@link Translation} e.g. for
378             * editing
379             *
380             * @return the destination {@link Translation}
381             */
382            @Override
383            public Translation copyTo(Translation translation2) {
384    
385                    if (translation2 == null)
386                            // throw new IllegalArgumentException(
387                            // "Target translation may not be null.");
388                            return copy();
389                    for (String s : keySet()) {
390                            translation2.put(s, get(s));
391                    }
392    
393                    return translation2;
394            }
395    
396            @Override
397            public Translation copy() {
398                    return copyTo(new Translation());
399            }
400    
401            /**
402             * Checks if the {@link String}s stored in the {@link Translation} are all
403             * valid.
404             *
405             * @return <code>true</code> if all good
406             */
407            public static boolean checkValid(Translation translationToCheck) {
408    
409                    for (String l : translationToCheck.values()) {
410    
411                            if (l.contains("{") || l.contains("}")) {
412    
413                                    return false;
414                            }
415                    }
416                    return true;
417            }
418    
419    }

Legend:
Removed from v.34  
changed lines
  Added in v.607

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26