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