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