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

Legend:
Removed from v.37  
changed lines
  Added in v.905

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26