/[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 268 by alfonx, Sat Aug 1 15:15:00 2009 UTC revision 1373 by alfonx, Wed Jan 19 12:59:51 2011 UTC
# Line 25  Line 25 
25   *   *
26   * Contributors:   * Contributors:
27   *     Martin O. J. Schmitz - initial API and implementation   *     Martin O. J. Schmitz - initial API and implementation
28   *     Stefan A. Krüger - additional utility classes   *     Stefan A. Tzeggai - additional utility classes
29   ******************************************************************************/   ******************************************************************************/
30  package skrueger.i8n;  package skrueger.i8n;
31    
32    import java.awt.event.ActionEvent;
33    import java.awt.event.ActionListener;
34  import java.beans.PropertyChangeEvent;  import java.beans.PropertyChangeEvent;
35  import java.beans.PropertyChangeListener;  import java.beans.PropertyChangeListener;
36    import java.io.Serializable;
37  import java.util.ArrayList;  import java.util.ArrayList;
38  import java.util.HashMap;  import java.util.HashMap;
39    import java.util.Iterator;
40  import java.util.List;  import java.util.List;
41  import java.util.Locale;  import java.util.Locale;
42    import java.util.Random;
43    import java.util.Set;
44    import java.util.WeakHashMap;
45    
46  import javax.swing.JComponent;  import javax.swing.JComponent;
47    
48  import org.apache.log4j.Logger;  import org.apache.log4j.Logger;
49    import org.geotools.util.WeakHashSet;
50    import org.opengis.util.InternationalString;
51    
52    import schmitzm.lang.ResourceProvider;
53    import schmitzm.lang.SortableVector;
54    import skrueger.geotools.Copyable;
55    
56  /**  /**
57   * Represents a {@link HashMap} of translations. toString() returns the   * Represents a {@link HashMap} of translations. toString() returns the
58   * appropriate translation   * appropriate translation. This class is mutable.
59   *   *
60   * @author @author <a href="mailto:[email protected]">Stefan Alfons   * @author <a href="mailto:[email protected]">Stefan Alfons Tzeggai</a>
  *         Kr&uuml;ger</a>  
61   */   */
62    
63  public class Translation extends HashMap<String, String> {  public class Translation extends HashMap<String, String> implements
64          public static final String LOCALECHANGE_PROPERTY = "localechange";                  Copyable<Translation>, Serializable, Cloneable {
65    
66            private static final long serialVersionUID = -347702744122305245L;
67    
68            public static final String LOCALE_CHANGE_PROPERTY = "localechange";
69            public static final String ACTIVELANG_CHANGE_PROPERTY = "activelangchange";
70          public static final String NO_TRANSLATION = "NO TRANSLATION";          public static final String NO_TRANSLATION = "NO TRANSLATION";
71          public static final String DEFAULT_KEY = "default";          public static final String DEFAULT_KEY = "default";
72          static final Logger log = Logger.getLogger(Translation.class);          static final Logger LOGGER = Logger.getLogger(Translation.class);
73    
74            /** A static field defining which language should be served **/
75          static String activeLang = Locale.getDefault().getLanguage();          static String activeLang = Locale.getDefault().getLanguage();
76    
77          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();          /**
78             * A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
79             * informed if the acitveLang has been changed with a setActiveLang(..,true
80             * or false).
81             */
82            static protected WeakHashSet<PropertyChangeListener> listenersActiveLangChange = new WeakHashSet<PropertyChangeListener>(
83                            PropertyChangeListener.class);
84    
85          static {          /**
86             * A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
87             * informed if the Locale has been changed due to a setActiveLang(..,true)
88             */
89            static protected WeakHashSet<PropertyChangeListener> listenersLocaleChange = new WeakHashSet<PropertyChangeListener>(
90                            PropertyChangeListener.class);
91    
92                  // TODO default aus Locale auslesen und mit möglichen vergleichen...          /**
93                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht           * A {@link WeakHashSet} of {@link PropertyChangeListener} that will be
94             * informed if any of the translations changed. TODO: Should be registerable
95             * for specific languages
96             */
97            private final WeakHashSet<ActionListener> changeListeners = new WeakHashSet<ActionListener>(
98                            ActionListener.class);
99    
100            static {
101                  // Get default locale                  // Get default locale
102                  Locale locale = Locale.getDefault();                  Locale locale = Locale.getDefault();
103                  setActiveLang(locale.getLanguage());                  setActiveLang(locale.getLanguage());
104          }          }
105    
106          @Override          @Override
107          /*          /**
108           * @comment To make a copy of a translation see methods toOneLine() and           * implemented using #toOneLine and #fromOneLine
          * fromOneLine()  
109           */           */
110          public Translation clone() {          public Translation clone() {
111                  return (Translation) super.clone();                  Translation clone = new Translation();
112                    clone.fromOneLine(toOneLine());
113                    return clone;
114          }          }
115    
116          /**          /**
# Line 86  public class Translation extends HashMap Line 123  public class Translation extends HashMap
123          /**          /**
124           * Set up the {@link Translation}-system to use language. If a change is           * Set up the {@link Translation}-system to use language. If a change is
125           * performed, events are fired to listeners. Nothing is done if the new           * performed, events are fired to listeners. Nothing is done if the new
126           * language equals the old language. The system's default locale is changed.           * language equals the old language. The system's default {@link Locale} is
127             * changed.
128           *           *
129           * @param newLang           * @param newLang
130           *            The ISO Code of the new active language           *            The ISO Code of the new active language
# Line 112  public class Translation extends HashMap Line 150  public class Translation extends HashMap
150                  }                  }
151    
152                  if (!I8NUtil.isValidISOLangCode(newLang)) {                  if (!I8NUtil.isValidISOLangCode(newLang)) {
                         throw new IllegalArgumentException("'" + newLang  
                                         + "' is not a valid ISO language code.");  
                 }  
153    
154                  Locale newLocale = new Locale(newLang);                          if (!I8NUtil.isPropertiesLanguage(newLang)) {
155                  if (setDefaultLocale)                                  throw new IllegalArgumentException(
156                          Locale.setDefault(newLocale);                                                  "'"
157                                                                    + newLang
158                                                                    + "' is not a valid ISO language code, nor is it a valid userdefined Properties code.");
159                            }
160    
161                  /**                  }
                  * Setting default locale for Swing JComponents to work around bug  
                  * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480  
                  */  
                 JComponent.setDefaultLocale(newLocale);  
162    
163                  Translation.activeLang = newLang;                  Translation.activeLang = newLang;
164                    fireActiveLangChangeEvents();
165    
166                  fireLocaleChangeEvents();                  Locale newLocale = new Locale(newLang);
167                    if (setDefaultLocale) {
168    
169                            setDefaultLocale(newLocale);
170    
171                            LOGGER.info(Translation.class.getName()
172                                            + " switched ActiveLang and Locale to " + newLang);
173                    } else {
174                            LOGGER.info(Translation.class.getName()
175                                            + " switched ActiveLang to " + newLang);
176                    }
177    
                 log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);  
178          }          }
179    
180          /**          /**
# Line 152  public class Translation extends HashMap Line 196  public class Translation extends HashMap
196    
197          /**          /**
198           * Initializes a new {@link Translation}, an uses the given String to           * Initializes a new {@link Translation}, an uses the given String to
199           * initialize the {@link Translation} for all languages codes passed.           * initialize the {@link Translation} for all languages codes passed. The
200             * translations can be changed later. This class is not immutable.
201             *
202             * @param languages
203             *            if empty or null, the given default {@link Translation} till
204             *            be stored under a special key {@link #DEFAULT_KEY}
205             *
206           *           *
          * The translations can be changed later  
207           */           */
208          public Translation(List<String> languages, String defaultTranslation) {          public Translation(List<String> languages, String defaultTranslation) {
209                  // put(DEFAULT_KEY, defaultTranslation);                  if (languages == null || languages.isEmpty()) {
                 if (languages == null) {  
210                          put(DEFAULT_KEY, defaultTranslation);                          put(DEFAULT_KEY, defaultTranslation);
211                  } else                  } else
212                          for (String code : languages) {                          for (String code : languages) {
213                                  if (code.equals(getActiveLang())) {                                  put(code, defaultTranslation);
                                         put(code, defaultTranslation);  
                                 }  
214                          }                          }
215          }          }
216    
# Line 183  public class Translation extends HashMap Line 229  public class Translation extends HashMap
229           * <li>If format can't be recognized, the {@link String} is interpreted as           * <li>If format can't be recognized, the {@link String} is interpreted as
230           * the translation in the <code>{@value #DEFAULT_KEY}</code> language           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
231           *           *
232           * @author Stefan Alfons Krüger           * @author Stefan Alfons Tzeggai
233           */           */
234          public void fromOneLine(final String oneLineCoded) {          public void fromOneLine(final String oneLineCoded) {
235    
236                  clear();                  clear();
                 if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {  
                         put(DEFAULT_KEY, "");  
                         return;  
                 }  
237    
238                  if (oneLineCoded.indexOf("}") == -1) {                  try {
239                          // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");  
240                          put(DEFAULT_KEY, oneLineCoded);                          if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
241                  }                                  put(DEFAULT_KEY, "");
242                                    return;
243                  String eatUp = oneLineCoded;                          }
244                  while (eatUp.indexOf("}") != -1) {  
245                          String substring = eatUp.substring(0, eatUp.indexOf("}"));                          if (oneLineCoded.indexOf("}") == -1) {
246                                    // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
247                          // log.debug("substring = "+substring);                                  put(DEFAULT_KEY, oneLineCoded);
248                          String key = substring.substring(0, substring.indexOf("{"));                          }
249                          String value = substring.substring(substring.indexOf("{") + 1,  
250                                          substring.length());                          String eatUp = oneLineCoded;
251                          // log.debug("key="+key);                          while (eatUp.indexOf("}") != -1) {
252                          // log.debug("value="+value);                                  String substring = eatUp.substring(0, eatUp.indexOf("}"));
253                          put(key, value);  
254                          eatUp = eatUp.substring(eatUp.indexOf("}") + 1);                                  // log.debug("substring = "+substring);
255                                    String key = substring.substring(0, substring.indexOf("{"));
256                                    String value = substring.substring(substring.indexOf("{") + 1,
257                                                    substring.length());
258                                    // log.debug("key="+key);
259                                    // log.debug("value="+value);
260                                    put(key, value);
261                                    eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
262                            }
263                    } catch (Exception e) {
264                            LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded
265                                            + "'", e);
266                            LOGGER.warn("Translation will be empty!");
267                  }                  }
268          }          }
269    
270          /**          /**
271           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
272           *           *
273           * @author Stefan Alfons Krüger           * @author Stefan Alfons Tzeggai
274           */           */
275          public String toOneLine() {          public String toOneLine() {
276                  return I8NUtil.toOneLine(this);                  return I8NUtil.toOneLine(this);
277          }          }
278    
279          /**          /**
280           * Returns the right translation by using the {@link #activeLang} field. If           * Returns the correct translation by using the {@link #activeLang} field.
281           * no translation is set, an ugly String {@link #NO_TRANSLATION} will re           * If no translation is set, an ugly String {@link #NO_TRANSLATION} will re
282           * returned. This might be changed for the final release. If the correct           * returned. This might be changed for the final release. If the correct
283           * language was not found, any entry in the {@link Translation}           * language was not found, any entry in the {@link Translation}
284           * {@link HashMap} will be returned, that contains more than an empty           * {@link HashMap} will be returned, that contains more than an empty
# Line 231  public class Translation extends HashMap Line 286  public class Translation extends HashMap
286           */           */
287          @Override          @Override
288          public String toString() {          public String toString() {
289                  if (get(activeLang) != null) {                  final String string = get(activeLang);
290                    if (string != null) {
291                          return get(activeLang);                          return get(activeLang);
292                  }                  }
293                  // ****************************************************************************                  // ****************************************************************************
# Line 240  public class Translation extends HashMap Line 296  public class Translation extends HashMap
296                  // ****************************************************************************                  // ****************************************************************************
297                  // else return "";                  // else return "";
298                  // //****************************************************************************                  // //****************************************************************************
299                  // // The following is commented out.. the concept of the default lang                  // // ST: The following is commented out.. the concept of the default
300                    // lang
301                  // seems to be bad....                  // seems to be bad....
302                  // //****************************************************************************                  // //****************************************************************************
303                  // MS:                  // MS:
304                  else {                  else {
305                          if (get(DEFAULT_KEY) != null) {                          if (get(DEFAULT_KEY) != null) {
                                 // 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.");  
306                                  return get(DEFAULT_KEY);                                  return get(DEFAULT_KEY);
307                          }                          }
308    
# Line 257  public class Translation extends HashMap Line 313  public class Translation extends HashMap
313                                                  return s;                                                  return s;
314                                  }                                  }
315                  }                  }
316  //              log.warn("No translation found!");                  // log.warn("No translation found!");
317                  return NO_TRANSLATION;                  return NO_TRANSLATION;
318          }          }
319    
320          /**          /**
321           * Copy this {@link Translation} to another {@link Translation} e.g. for           * {@link PropertyChangeListener} can be registered to be informed when the
322           * editing           * {@link Locale} changed.<br>
323             * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
324             * reference to the listener or it will be removed!
325           *           *
326           * @return the destination {@link Translation}           * @param propertyChangeListener
327             *            A {@link PropertyChangeListener} that will be called when
328             *            {@link #setActiveLang(String)} changes the language.
329           */           */
330          public Translation copy(Translation backup) {          public static void addLocaleChangeListener(
331                  if (backup == null)                          PropertyChangeListener propertyChangeListener) {
332                          throw new IllegalArgumentException(                  listenersLocaleChange.add(propertyChangeListener);
                                         "Target translation may not be null.");  
                 for (String s : keySet()) {  
                         backup.put(s, get(s));  
                 }  
                 return backup;  
333          }          }
334    
335          /**          /**
336           * {@link PropertyChangeListener} can be registered to be informed when the           * {@link PropertyChangeListener} can be registered to be informed when the
337           * {@link Locale} changed.           * {@link Locale} changed.<br>
338             * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
339             * reference to the listener or it will be removed!
340           *           *
341           * @param propertyChangeListener           * @param propertyChangeListener
342             *            A {@link PropertyChangeListener} that will be called when
343             *            {@link #setActiveLang(String)} changes the language.
344           */           */
345          public static void addLocaleChangeListener(          public static boolean removeLocaleChangeListener(
346                            PropertyChangeListener propertyChangeListener) {
347                    return listenersLocaleChange.remove(propertyChangeListener);
348            }
349    
350            /**
351             * {@link PropertyChangeListener} can be registered to be informed when the
352             * {@link Locale} changed.<br>
353             * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
354             * reference to the listener or it will be removed!
355             *
356             * @param propertyChangeListener
357             *            A {@link PropertyChangeListener} that will be called when
358             *            {@link #setActiveLang(String)} changes the language.
359             */
360            public static void addActiveLangChangeListener(
361                            PropertyChangeListener propertyChangeListener) {
362                    listenersActiveLangChange.add(propertyChangeListener);
363            }
364    
365            /**
366             * {@link PropertyChangeListener} can be registered to be informed when the
367             * {@link Locale} changed.<br>
368             * The listeners are kept in a {@link WeakHashMap}, so you have to keep a
369             * reference to the listener or it will be removed!
370             *
371             * @param propertyChangeListener
372             *            A {@link PropertyChangeListener} that will be called when
373             *            {@link #setActiveLang(String)} changes the language.
374             */
375            public static boolean removeActiveLangListener(
376                          PropertyChangeListener propertyChangeListener) {                          PropertyChangeListener propertyChangeListener) {
377                  listeners.add(propertyChangeListener);                  return listenersActiveLangChange.remove(propertyChangeListener);
378          }          }
379    
380          /**          /**
381           * Informs all registered {@link PropertyChangeListener}s about a change of           * Informs all registered {@link PropertyChangeListener}s about a change of
382           * the the {@link Locale}.           * type LOCALE_CHANGE_PROPERTY the the {@link Locale}.
383           */           */
384          public static void fireLocaleChangeEvents() {          public static void fireLocaleChangeEvents() {
385                  PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(                  PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
386                                  new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,                                  new ArrayList<String>(), "fakeSource"), LOCALE_CHANGE_PROPERTY,
387                                  null, getActiveLang());                                  null, getActiveLang());
388                  for (PropertyChangeListener pcl : listeners) {                  for (PropertyChangeListener pcl : listenersLocaleChange) {
389                            if (pcl != null)
390                                    pcl.propertyChange(pce);
391                    }
392            }
393    
394            /**
395             * Informs all registered {@link PropertyChangeListener}s about a change of
396             * type ACTIVELANG_CHANGE_PROPERTY the the {@link Locale}.
397             */
398            public static void fireActiveLangChangeEvents() {
399                    PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
400                                    new ArrayList<String>(), "fakeSource"),
401                                    ACTIVELANG_CHANGE_PROPERTY, null, getActiveLang());
402                    for (PropertyChangeListener pcl : listenersActiveLangChange) {
403                          if (pcl != null)                          if (pcl != null)
404                                  pcl.propertyChange(pce);                                  pcl.propertyChange(pce);
405                  }                  }
406          }          }
407    
408            /**
409             * The listeneras are stored in a {@link WeakHashSet}! So you HAVE TO KEEP a
410             * reference as long as you need the listener.
411             */
412            public void addTranslationChangeListener(ActionListener actionListener) {
413                    if (changeListeners.add(actionListener)) {
414                            // LOGGER
415                            // .debug("registering a new translationChangeActionListener in the WeakHashSet");
416                    }
417            }
418    
419            /**
420             * The listeneras are stored in a {@link WeakHashSet}! You don't have to
421             * remove the listener, as long as you throw away the reference to the
422             * listener.
423             */
424            public boolean removeTranslationChangeListener(ActionListener actionListener) {
425                    return changeListeners.remove(actionListener);
426            }
427    
428            public void fireTranslationChangedEvents(String lang) {
429                    ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);
430    
431                    final Iterator<ActionListener> iterator = changeListeners.iterator();
432                    while (iterator.hasNext()) {
433                            ActionListener al = iterator.next();
434                            al.actionPerformed(ae);
435                    }
436            }
437    
438            @Override
439            public String put(String lang, String value) {
440                    String result = super.put(lang, value);
441                    fireTranslationChangedEvents(lang);
442                    return result;
443            }
444    
445            public void fromOneLine(InternationalString iString) {
446                    if (iString != null)
447                            fromOneLine(iString.toString());
448                    else
449                            fromOneLine((String) null);
450            }
451    
452            /**
453             * Copy this {@link Translation} to another {@link Translation} e.g. for
454             * editing and return the target.
455             *
456             * @return the destination {@link Translation}
457             */
458            @Override
459            public Translation copyTo(Translation translation2) {
460                    if (translation2 == null)
461                            return copy();
462    
463                    translation2.fromOneLine(toOneLine());
464                    return translation2;
465            }
466    
467            @Override
468            public Translation copy() {
469                    return copyTo(new Translation());
470            }
471    
472            /**
473             * Checks if the {@link String}s stored in the {@link Translation} are all
474             * valid.
475             *
476             * @return <code>true</code> if all good
477             */
478            public static boolean checkValid(Translation translationToCheck) {
479    
480                    for (String l : translationToCheck.values()) {
481    
482                            if (l.contains("{") || l.contains("}")) {
483    
484                                    return false;
485                            }
486                    }
487                    return true;
488            }
489    
490            /**
491             * Goes through the available languages of the FIRST registered
492             * {@link ResourceProvider} and set the active locale to the fist match.
493             *
494             * @param fireChangeEvent
495             *            if <code>true</code>, a Translation.fireLocaleChangeEvents()
496             *            is issued.
497             *
498             * @return
499             */
500            public static boolean setFirstmatchingLanguage(List<String> languages,
501                            boolean fireChangeEvent) {
502    
503                    SortableVector<ResourceProvider> registeredResourceProvider = ResourceProvider
504                                    .getRegisteredResourceProvider();
505                    Set<Locale> available = ResourceProvider.getAvailableLocales(
506                                    registeredResourceProvider.get(0), true);
507    
508                    for (String l : languages) {
509                            for (Locale loc : available) {
510                                    if (loc.getLanguage().equals(l)) {
511                                            Translation.setActiveLang(l);
512                                            if (fireChangeEvent)
513                                                    Translation.fireLocaleChangeEvents();
514                                            return true;
515                                    }
516                            }
517                    }
518    
519                    return false;
520    
521            }
522    
523            /**
524             * Returns the translation in a requested language
525             */
526            public String toString(String lang) {
527                    return get(lang);
528            }
529    
530            /**
531             * Will set the default Locale (if not already equal) and fire Locale change
532             * events.
533             *
534             * @param if <code>null</code> will do nothing.
535             */
536            public static void setDefaultLocale(Locale locale) {
537    
538                    if (locale == null)
539                            return;
540    
541                    if (I8NUtil.isPropertiesLanguage(locale.getLanguage())) {
542                            locale = I8NUtil.propLocales.get(locale.getLanguage())
543                                            .getParentLocale();
544                    }
545    
546                    if (Locale.getDefault().equals(locale))
547                            return;
548                    Locale.setDefault(locale);
549                    /**
550                     * Setting default locale for Swing JComponents to work around bug
551                     * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
552                     */
553                    JComponent.setDefaultLocale(locale);
554    
555                    fireLocaleChangeEvents();
556            }
557    
558  }  }
Legend:
Removed from v.268  
changed lines
  Added in v.1373
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26