/[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 39 by alfonx, Mon Apr 6 19:14:55 2009 UTC revision 905 by alfonx, Thu Jun 10 08:00:37 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     * This program is free software; you can redistribute it and/or
12  import org.apache.log4j.Logger;   * modify it under the terms of the GNU Lesser General Public License
13     * as published by the Free Software Foundation; either version 3
14  /**   * of the License, or (at your option) any later version.
15   * Represents a {@link HashMap} of translations. toString() returns the   *
16   * appropriate translation   * This program is distributed in the hope that it will be useful,
17   *   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * @author @author <a href="mailto:[email protected]">Stefan Alfons   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19   *         Kr&uuml;ger</a>   * GNU General Public License for more details.
20   */   *
21     * You should have received a copy of the GNU Lesser General Public License (license.txt)
22  public class Translation extends HashMap<String, String> {   * along with this program; if not, write to the Free Software
23          public static final String LOCALECHANGE_PROPERTY = "localechange";   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24          public static final String NO_TRANSLATION = "NO TRANSLATION";   * or try this link: http://www.gnu.org/licenses/lgpl.html
25          public static final String DEFAULT_KEY = "default";   *
26          static final Logger log = Logger.getLogger(Translation.class);   * Contributors:
27          static String activeLang = "fr";   *     Martin O. J. Schmitz - initial API and implementation
28     *     Stefan A. Tzeggai - additional utility classes
29          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();   ******************************************************************************/
30    package skrueger.i8n;
31          static {  
32    import java.awt.event.ActionEvent;
33                  // TODO default aus Locale auslesen und mit möglichen vergleichen...  import java.awt.event.ActionListener;
34                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht  import java.beans.PropertyChangeEvent;
35    import java.beans.PropertyChangeListener;
36                  // Get default locale  import java.io.Serializable;
37                  Locale locale = Locale.getDefault();  import java.util.ArrayList;
38                  setActiveLang(locale.getLanguage());  import java.util.HashMap;
39          }  import java.util.Iterator;
40    import java.util.List;
41          @Override  import java.util.Locale;
42          /*  import java.util.Random;
43           * @comment To make a copy of a translation see methods toOneLine() and  import java.util.Set;
44           * fromOneLine()  import java.util.WeakHashMap;
45           */  
46          public Translation clone() {  import javax.swing.JComponent;
47                  return (Translation) super.clone();  
48          }  import org.apache.log4j.Logger;
49    import org.geotools.util.WeakHashSet;
50          /**  import org.opengis.util.InternationalString;
51           * Get the two-letter language sting that is active  
52           */  import schmitzm.lang.ResourceProvider;
53          public static String getActiveLang() {  import schmitzm.lang.SortableVector;
54                  return activeLang;  import skrueger.geotools.Copyable;
55          }  
56    /**
57          /**   * Represents a {@link HashMap} of translations. toString() returns the
58           * Set up the {@link Translation}-system to use language. If a change is   * appropriate translation
59           * performed, events are fired to listeners. Nothing is done if the new   *
60           * language equals the old language.   * @author @author <a href="mailto:[email protected]">Stefan Alfons
61           *   *         Tzeggai</a>
62           * @param newLang   */
63           *            The ISO Code of the new active language  
64           */  public class Translation extends HashMap<String, String> implements
65          public static void setActiveLang(String newLang) {                  Copyable<Translation>, Serializable {
66                  if (getActiveLang().equals(newLang)) {  
67                          return;          private static final long serialVersionUID = -347702744122305245L;
68                  }  
69            public static final String LOCALECHANGE_PROPERTY = "localechange";
70                  if (!I8NUtil.isValidISOLangCode(newLang)) {          public static final String NO_TRANSLATION = "NO TRANSLATION";
71                          throw new IllegalArgumentException("'" + newLang          public static final String DEFAULT_KEY = "default";
72                                          + "' is not a valid ISO language code.");          static final Logger LOGGER = Logger.getLogger(Translation.class);
73                  }          static String activeLang = Locale.getDefault().getLanguage();
74    
75                  Locale newLocale = new Locale(newLang);          static protected WeakHashSet<PropertyChangeListener> listeners = new WeakHashSet<PropertyChangeListener>(
76                  Locale.setDefault(newLocale);                          PropertyChangeListener.class);
77    
78                  /**          static {
79                   * Setting default locale for Swing JComponents to work around bug  
80                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
81                   */                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
82                  JComponent.setDefaultLocale(newLocale);  
83                    // Get default locale
84                  Translation.activeLang = newLang;                  Locale locale = Locale.getDefault();
85                    setActiveLang(locale.getLanguage());
86                  fireChangeEvents();          }
87    
88                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);          private WeakHashSet<ActionListener> actionListeners = new WeakHashSet<ActionListener>(
89          }                          ActionListener.class);
90    
91          /**          @Override
92           * Initializes a new {@link Translation} with a default translation. Other          /*
93           * translations may be added later.           * @comment To make a copy of a translation see methods toOneLine() and
94           *           * fromOneLine()
95           * @param defaultTranslation           */
96           *          public Translation clone() {
97           * @deprecated SK: The concept of the default translation doesn't seem so                  throw new RuntimeException("use copy()");
98           *             nice to me anymore.. I would prefer the default translation                  // return (Translation) super.clone();
99           *             to be set for all valid languages.          }
100           *  
101           * @see public Translation(List<String> languages, String          /**
102           *      defaultTranslation) {           * Get the two-letter language sting that is active
103           *           */
104           */          public static String getActiveLang() {
105          public Translation(String defaultTranslation) {                  return activeLang;
106                  put(DEFAULT_KEY, defaultTranslation);          }
107          }  
108            /**
109          /**           * Set up the {@link Translation}-system to use language. If a change is
110           * Initializes a new {@link Translation}, an uses the given String to           * performed, events are fired to listeners. Nothing is done if the new
111           * initialize the {@link Translation} for all languages codes passed.           * language equals the old language. The system's default {@link Locale} is changed.
112           *           *
113           * The translations can be changed later           * @param newLang
114           */           *            The ISO Code of the new active language
115          public Translation(List<String> languages, String defaultTranslation) {           */
116                  // put(DEFAULT_KEY, defaultTranslation);          public static void setActiveLang(String newLang) {
117                  if (languages == null) {                  setActiveLang(newLang, true);
118                          put(DEFAULT_KEY, defaultTranslation);          }
119                  } else  
120                          for (String code : languages) {          /**
121                                  if (code.equals(getActiveLang())) {           * Set up the {@link Translation}-system to use language. If a change is
122                                          put(code, defaultTranslation);           * performed, events are fired to listeners. Nothing is done if the new
123                                  }           * language equals the old language.
124                          }           *
125          }           * @param newLang
126             *            The ISO Code of the new active language
127          /**           *
128           * Sometimes Translations are optional, like for keywords.           * @param setDefaultLocale
129           */           *            Shall the system's default locale be changed?
130          public Translation() {           */
131                  super();          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
132          }                  if (getActiveLang().equals(newLang)) {
133                            return;
134          /**                  }
135           * Fills the {@link Translation} with the values coded into the String  
136           * Format of {@link String} is: "de{Baum}en{tree}"                  if (!I8NUtil.isValidISOLangCode(newLang)) {
137           * <p>                          throw new IllegalArgumentException("'" + newLang
138           * <ul>                                          + "' is not a valid ISO language code.");
139           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.                  }
140           * <li>If format can't be recognized, the {@link String} is interpreted as  
141           * the translation in the <code>{@value #DEFAULT_KEY}</code> language                  Locale newLocale = new Locale(newLang);
142           *                  if (setDefaultLocale)
143           * @author Stefan Alfons Krüger                          Locale.setDefault(newLocale);
144           */  
145          public void fromOneLine(final String oneLineCoded) {                  /**
146                  clear();                   * Setting default locale for Swing JComponents to work around bug
147                  if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
148                          put(DEFAULT_KEY, NO_TRANSLATION);                   */
149                          return;                  JComponent.setDefaultLocale(newLocale);
150                  }  
151                    Translation.activeLang = newLang;
152                  if (oneLineCoded.indexOf("}") == -1) {  
153                          // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");                  fireLocaleChangeEvents();
154                          put(DEFAULT_KEY, oneLineCoded);  
155                  }                  LOGGER.info("skrueger.i8n.Translation switched ActiveLang to "
156                                    + newLang);
157                  String eatUp = oneLineCoded;          }
158                  while (eatUp.indexOf("}") != -1) {  
159                          String substring = eatUp.substring(0, eatUp.indexOf("}"));          /**
160             * Initializes a new {@link Translation} with a default translation if a
161                          // log.debug("substring = "+substring);           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
162                          String key = substring.substring(0, substring.indexOf("{"));           * Other translations may be added later - this is a HashMap<br/>
163                          String value = substring.substring(substring.indexOf("{") + 1,           *
164                                          substring.length());           * @param defaultTranslation
165                          // log.debug("key="+key);           *
166                          // log.debug("value="+value);           * @see public Translation(List<String> languages, String
167                          put(key, value);           *      defaultTranslation) {
168                          eatUp = eatUp.substring(eatUp.indexOf("}") + 1);           *
169                  }           */
170          }          public Translation(String defaultTranslation) {
171    
172          /**                  fromOneLine(defaultTranslation);
173           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"  
174           *          }
175           * @author Stefan Alfons Krüger  
176           */          /**
177          public String toOneLine() {           * Initializes a new {@link Translation}, an uses the given String to
178                  StringBuffer oneLine = new StringBuffer();           * initialize the {@link Translation} for all languages codes passed.
179                  for (String key : keySet()) {           *
180                          oneLine.append(key + "{" + get(key) + "}");           * The translations can be changed later
181                  }           */
182                  return oneLine.toString();          public Translation(List<String> languages, String defaultTranslation) {
183          }                  // put(DEFAULT_KEY, defaultTranslation);
184                    if (languages == null) {
185          /**                          put(DEFAULT_KEY, defaultTranslation);
186           * Returns the right translation by using the {@link #activeLang} field. If                  } else
187           * no translation is set, an ugly String {@link #NO_TRANSLATION} will re                          for (String code : languages) {
188           * returned. This might be changed for the final release. If the correct                                  // if (code.equals(getActiveLang())) {
189           * language was not found, any entry in the {@link Translation}                                  put(code, defaultTranslation);
190           * {@link HashMap} will be returned, that contains more than an empty                                  // }
191           * string.                          }
192           */          }
193          @Override  
194          public String toString() {          /**
195                  if (get(activeLang) != null) {           * Sometimes Translations are optional, like for keywords.
196                          return get(activeLang);           */
197                  }          public Translation() {
198                  // ****************************************************************************          }
199                  // MS: The ISDSS needs the concept of the default lang!! So I took the  
200                  // following in again!!          /**
201                  // ****************************************************************************           * Fills the {@link Translation} with the values coded into the String
202                  // else return "";           * Format of {@link String} is: "de{Baum}en{tree}"
203                  // //****************************************************************************           * <p>
204                  // // The following is commented out.. the concept of the default lang           * <ul>
205                  // seems to be bad....           * <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                  // MS:           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
208                  else {           *
209                          if (get(DEFAULT_KEY) != null) {           * @author Stefan Alfons Tzeggai
210                                  // 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.");           */
211                                  return get(DEFAULT_KEY);          public void fromOneLine(final String oneLineCoded) {
212                          }  
213                    clear();
214                          // log.debug("return first best <> '' ");  
215                          if (size() > 0)                  try {
216                                  for (String s : values()) {  
217                                          if ((s != null) && (s.trim().length() > 0))                          if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
218                                                  return s;                                  put(DEFAULT_KEY, "");
219                                  }                                  return;
220                  }                          }
221                  log.warn("No translation found!");  
222                  return NO_TRANSLATION;                          if (oneLineCoded.indexOf("}") == -1) {
223          }                                  // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
224                                    put(DEFAULT_KEY, oneLineCoded);
225          /**                          }
226           * Copy this {@link Translation} to another {@link Translation} e.g. for  
227           * editing                          String eatUp = oneLineCoded;
228           *                          while (eatUp.indexOf("}") != -1) {
229           * @return the destination {@link Translation}                                  String substring = eatUp.substring(0, eatUp.indexOf("}"));
230           */  
231          public Translation copy(Translation backup) {                                  // log.debug("substring = "+substring);
232                  if (backup == null)                                  String key = substring.substring(0, substring.indexOf("{"));
233                          throw new IllegalArgumentException(                                  String value = substring.substring(substring.indexOf("{") + 1,
234                                          "Target translation may not be null.");                                                  substring.length());
235                  for (String s : keySet()) {                                  // log.debug("key="+key);
236                          backup.put(s, get(s));                                  // log.debug("value="+value);
237                  }                                  put(key, value);
238                  return backup;                                  eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
239          }                          }
240                    } catch (Exception e) {
241          /**                          LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded
242           * {@link PropertyChangeListener} can be registered to be informed when the                                          + "'", e);
243           * {@link Locale} changed.                          LOGGER.warn("Translation will be empty!");
244           *                  }
245           * @param propertyChangeListener          }
246           */  
247          public static void addLocaleChangeListener(          /**
248                          PropertyChangeListener propertyChangeListener) {           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
249                  listeners.add(propertyChangeListener);           *
250          }           * @author Stefan Alfons Tzeggai
251             */
252          /**          public String toOneLine() {
253           * Informs all registered {@link PropertyChangeListener}s about a change of                  return I8NUtil.toOneLine(this);
254           * the the {@link Locale}.          }
255           */  
256          public static void fireChangeEvents() {          /**
257                  PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(           * Returns the right translation by using the {@link #activeLang} field. If
258                                  new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,           * no translation is set, an ugly String {@link #NO_TRANSLATION} will re
259                                  null, getActiveLang());           * returned. This might be changed for the final release. If the correct
260                  for (PropertyChangeListener pcl : listeners) {           * language was not found, any entry in the {@link Translation}
261                          if (pcl != null)           * {@link HashMap} will be returned, that contains more than an empty
262                                  pcl.propertyChange(pce);           * 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.39  
changed lines
  Added in v.905

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26