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