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