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

Legend:
Removed from v.185  
changed lines
  Added in v.772

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26