/[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 685 by alfonx, Wed Feb 10 15:04:02 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. Krüger - 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.util.ArrayList;
37                  Locale locale = Locale.getDefault();  import java.util.HashMap;
38                  setActiveLang(locale.getLanguage());  import java.util.Iterator;
39          }  import java.util.List;
40    import java.util.Locale;
41          @Override  import java.util.Random;
42          /*  import java.util.WeakHashMap;
43           * @comment To make a copy of a translation see methods toOneLine() and  
44           * fromOneLine()  import javax.swing.JComponent;
45           */  
46          public Translation clone() {  import org.apache.log4j.Logger;
47                  return (Translation) super.clone();  import org.geotools.util.WeakHashSet;
48          }  import org.opengis.util.InternationalString;
49    
50          /**  import skrueger.geotools.Copyable;
51           * Get the two-letter language sting that is active  
52           */  /**
53          public static String getActiveLang() {   * Represents a {@link HashMap} of translations. toString() returns the
54                  return activeLang;   * appropriate translation
55          }   *
56     * @author @author <a href="mailto:[email protected]">Stefan Alfons
57          /**   *         Kr&uuml;ger</a>
58           * Set up the {@link Translation}-system to use language. If a change is   */
59           * performed, events are fired to listeners. Nothing is done if the new  
60           * language equals the old language.  public class Translation extends HashMap<String, String> implements
61           *                  Copyable<Translation> {
62           * @param newLang          public static final String LOCALECHANGE_PROPERTY = "localechange";
63           *            The ISO Code of the new active language          public static final String NO_TRANSLATION = "NO TRANSLATION";
64           */          public static final String DEFAULT_KEY = "default";
65          public static void setActiveLang(String newLang) {          static final Logger LOGGER = Logger.getLogger(Translation.class);
66                  if (getActiveLang().equals(newLang)) {          static String activeLang = Locale.getDefault().getLanguage();
67                          return;  
68                  }          static protected WeakHashSet<PropertyChangeListener> listeners = new WeakHashSet<PropertyChangeListener>(
69                            PropertyChangeListener.class);
70                  if (!I8NUtil.isValidISOLangCode(newLang)) {  
71                          throw new IllegalArgumentException("'" + newLang          static {
72                                          + "' is not a valid ISO language code.");  
73                  }                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
74                    // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
75                  Locale newLocale = new Locale(newLang);  
76                  Locale.setDefault(newLocale);                  // Get default locale
77                    Locale locale = Locale.getDefault();
78                  /**                  setActiveLang(locale.getLanguage());
79                   * Setting default locale for Swing JComponents to work around bug          }
80                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480  
81                   */          private WeakHashSet<ActionListener> actionListeners = new WeakHashSet<ActionListener>(
82                  JComponent.setDefaultLocale(newLocale);                          ActionListener.class);
83    
84                  Translation.activeLang = newLang;          @Override
85            /*
86                  fireChangeEvents();           * @comment To make a copy of a translation see methods toOneLine() and
87             * fromOneLine()
88                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);           */
89          }          public Translation clone() {
90                    throw new RuntimeException("use copy()");
91          /**                  // return (Translation) super.clone();
92           * Initializes a new {@link Translation} with a default translation. Other          }
93           * translations may be added later.  
94           *          /**
95           * @param defaultTranslation           * Get the two-letter language sting that is active
96           *           */
97           * @deprecated SK: The concept of the default translation doesn't seem so          public static String getActiveLang() {
98           *             nice to me anymore.. I would prefer the default translation                  return activeLang;
99           *             to be set for all valid languages.          }
100           *  
101           * @see public Translation(List<String> languages, String          /**
102           *      defaultTranslation) {           * Set up the {@link Translation}-system to use language. If a change is
103           *           * 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          public Translation(String defaultTranslation) {           *
106                  put(DEFAULT_KEY, defaultTranslation);           * @param newLang
107          }           *            The ISO Code of the new active language
108             */
109          /**          public static void setActiveLang(String newLang) {
110           * Initializes a new {@link Translation}, an uses the given String to                  setActiveLang(newLang, true);
111           * initialize the {@link Translation} for all languages codes passed.          }
112           *  
113           * The translations can be changed later          /**
114           */           * Set up the {@link Translation}-system to use language. If a change is
115          public Translation(List<String> languages, String defaultTranslation) {           * performed, events are fired to listeners. Nothing is done if the new
116                  // put(DEFAULT_KEY, defaultTranslation);           * language equals the old language.
117                  if (languages == null) {           *
118                          put(DEFAULT_KEY, defaultTranslation);           * @param newLang
119                  } else           *            The ISO Code of the new active language
120                          for (String code : languages) {           *
121                                  if (code.equals(getActiveLang())) {           * @param setDefaultLocale
122                                          put(code, defaultTranslation);           *            Shall the system's default locale be changed?
123                                  }           */
124                          }          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
125          }                  if (getActiveLang().equals(newLang)) {
126                            return;
127          /**                  }
128           * Sometimes Translations are optional, like for keywords.  
129           */                  if (!I8NUtil.isValidISOLangCode(newLang)) {
130          public Translation() {                          throw new IllegalArgumentException("'" + newLang
131                  super();                                          + "' is not a valid ISO language code.");
132          }                  }
133    
134          /**                  Locale newLocale = new Locale(newLang);
135           * Fills the {@link Translation} with the values coded into the String                  if (setDefaultLocale)
136           * Format of {@link String} is: "de{Baum}en{tree}"                          Locale.setDefault(newLocale);
137           * <p>  
138           * <ul>                  /**
139           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.                   * Setting default locale for Swing JComponents to work around bug
140           * <li>If format can't be recognized, the {@link String} is interpreted as                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
141           * the translation in the <code>{@value #DEFAULT_KEY}</code> language                   */
142           *                  JComponent.setDefaultLocale(newLocale);
143           * @author Stefan Alfons Krüger  
144           */                  Translation.activeLang = newLang;
145          public void fromOneLine(final String oneLineCoded) {  
146                  clear();                  fireLocaleChangeEvents();
147                  if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {  
148                          put(DEFAULT_KEY, NO_TRANSLATION);                  LOGGER.info("skrueger.i8n.Translation switched ActiveLang to "
149                          return;                                  + newLang);
150                  }          }
151    
152                  if (oneLineCoded.indexOf("}") == -1) {          /**
153                          // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");           * Initializes a new {@link Translation} with a default translation if a
154                          put(DEFAULT_KEY, oneLineCoded);           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
155                  }           * Other translations may be added later - this is a HashMap<br/>
156             *
157                  String eatUp = oneLineCoded;           * @param defaultTranslation
158                  while (eatUp.indexOf("}") != -1) {           *
159                          String substring = eatUp.substring(0, eatUp.indexOf("}"));           * @see public Translation(List<String> languages, String
160             *      defaultTranslation) {
161                          // log.debug("substring = "+substring);           *
162                          String key = substring.substring(0, substring.indexOf("{"));           */
163                          String value = substring.substring(substring.indexOf("{") + 1,          public Translation(String defaultTranslation) {
164                                          substring.length());  
165                          // log.debug("key="+key);                  fromOneLine(defaultTranslation);
166                          // log.debug("value="+value);  
167                          put(key, value);          }
168                          eatUp = eatUp.substring(eatUp.indexOf("}") + 1);  
169                  }          /**
170          }           * Initializes a new {@link Translation}, an uses the given String to
171             * initialize the {@link Translation} for all languages codes passed.
172          /**           *
173           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"           * The translations can be changed later
174           *           */
175           * @author Stefan Alfons Krüger          public Translation(List<String> languages, String defaultTranslation) {
176           */                  // put(DEFAULT_KEY, defaultTranslation);
177          public String toOneLine() {                  if (languages == null) {
178                  StringBuffer oneLine = new StringBuffer();                          put(DEFAULT_KEY, defaultTranslation);
179                  for (String key : keySet()) {                  } else
180                          oneLine.append(key + "{" + get(key) + "}");                          for (String code : languages) {
181                  }  //                              if (code.equals(getActiveLang())) {
182                  return oneLine.toString();                                          put(code, defaultTranslation);
183          }  //                              }
184                            }
185          /**          }
186           * Returns the right translation by using the {@link #activeLang} field. If  
187           * no translation is set, an ugly String {@link #NO_TRANSLATION} will re          /**
188           * returned. This might be changed for the final release. If the correct           * Sometimes Translations are optional, like for keywords.
189           * language was not found, any entry in the {@link Translation}           */
190           * {@link HashMap} will be returned, that contains more than an empty          public Translation() {
191           * string.          }
192           */  
193          @Override          /**
194          public String toString() {           * Fills the {@link Translation} with the values coded into the String
195                  if (get(activeLang) != null) {           * Format of {@link String} is: "de{Baum}en{tree}"
196                          return get(activeLang);           * <p>
197                  }           * <ul>
198                  // ****************************************************************************           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
199                  // MS: The ISDSS needs the concept of the default lang!! So I took the           * <li>If format can't be recognized, the {@link String} is interpreted as
200                  // following in again!!           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
201                  // ****************************************************************************           *
202                  // else return "";           * @author Stefan Alfons Krüger
203                  // //****************************************************************************           */
204                  // // The following is commented out.. the concept of the default lang          public void fromOneLine(final String oneLineCoded) {
205                  // seems to be bad....  
206                  // //****************************************************************************                  clear();
207                  // MS:  
208                  else {                  try {
209                          if (get(DEFAULT_KEY) != null) {  
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.");                          if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
211                                  return get(DEFAULT_KEY);                                  put(DEFAULT_KEY, "");
212                          }                                  return;
213                            }
214                          // log.debug("return first best <> '' ");  
215                          if (size() > 0)                          if (oneLineCoded.indexOf("}") == -1) {
216                                  for (String s : values()) {                                  // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
217                                          if ((s != null) && (s.trim().length() > 0))                                  put(DEFAULT_KEY, oneLineCoded);
218                                                  return s;                          }
219                                  }  
220                  }                          String eatUp = oneLineCoded;
221                  log.warn("No translation found!");                          while (eatUp.indexOf("}") != -1) {
222                  return NO_TRANSLATION;                                  String substring = eatUp.substring(0, eatUp.indexOf("}"));
223          }  
224                                    // log.debug("substring = "+substring);
225          /**                                  String key = substring.substring(0, substring.indexOf("{"));
226           * Copy this {@link Translation} to another {@link Translation} e.g. for                                  String value = substring.substring(substring.indexOf("{") + 1,
227           * editing                                                  substring.length());
228           *                                  // log.debug("key="+key);
229           * @return the destination {@link Translation}                                  // log.debug("value="+value);
230           */                                  put(key, value);
231          public Translation copy(Translation backup) {                                  eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
232                  if (backup == null)                          }
233                          throw new IllegalArgumentException(                  } catch (Exception e) {
234                                          "Target translation may not be null.");                          LOGGER.warn("Error while reading the oneLineCode '" + oneLineCoded
235                  for (String s : keySet()) {                                          + "'", e);
236                          backup.put(s, get(s));                          LOGGER.warn("Translation will be empty!");
237                  }                  }
238                  return backup;          }
239          }  
240            /**
241          /**           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
242           * {@link PropertyChangeListener} can be registered to be informed when the           *
243           * {@link Locale} changed.           * @author Stefan Alfons Krüger
244           *           */
245           * @param propertyChangeListener          public String toOneLine() {
246           */                  return I8NUtil.toOneLine(this);
247          public static void addLocaleChangeListener(          }
248                          PropertyChangeListener propertyChangeListener) {  
249                  listeners.add(propertyChangeListener);          /**
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           * Informs all registered {@link PropertyChangeListener}s about a change of           * language was not found, any entry in the {@link Translation}
254           * the the {@link Locale}.           * {@link HashMap} will be returned, that contains more than an empty
255           */           * string.
256          public static void fireChangeEvents() {           */
257                  PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(          @Override
258                                  new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,          public String toString() {
259                                  null, getActiveLang());                  if (get(activeLang) != null) {
260                  for (PropertyChangeListener pcl : listeners) {                          return get(activeLang);
261                          if (pcl != null)                  }
262                                  pcl.propertyChange(pce);                  // ****************************************************************************
263                  }                  // MS: The ISDSS needs the concept of the default lang!! So I took the
264          }                  // following in again!!
265                    // ****************************************************************************
266                    // else return "";
267  }                  // //****************************************************************************
268                    // // The following is commented out.. the concept of the default lang
269                    // seems to be bad....
270                    // //****************************************************************************
271                    // MS:
272                    else {
273                            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.39  
changed lines
  Added in v.685

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26