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

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

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

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

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

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26