/[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/1.0-gt2-2.6/src/skrueger/i8n/Translation.java revision 420 by alfonx, Thu Oct 1 20:22:48 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.List;
39          /**  import java.util.Locale;
40           * @comment To make a copy of a translation see methods toOneLine() and fromOneLine()  import java.util.Random;
41           */  
42          public Translation clone() {  import javax.swing.JComponent;
43                  return (Translation) super.clone();  
44          }  import org.apache.log4j.Logger;
45    import org.opengis.util.InternationalString;
46          /**  
47           * Get the two-letter language sting that is active  import skrueger.geotools.Copyable;
48           */  
49          public static String getActiveLang() {  /**
50                  return activeLang;   * Represents a {@link HashMap} of translations. toString() returns the
51          }   * appropriate translation
52     *
53          /**   * @author @author <a href="mailto:[email protected]">Stefan Alfons
54           * Set up the {@link Translation}-system to use language.   *         Kr&uuml;ger</a>
55           * @param activeLang   */
56           */  
57          public static void setActiveLang(String activeLang) {  public class Translation extends HashMap<String, String> implements Copyable<Translation>{
58                  if (!I8NUtil.isValidISOLangCode(activeLang)) {          public static final String LOCALECHANGE_PROPERTY = "localechange";
59                          throw new IllegalArgumentException("'"+activeLang+"' is not a valid ISO language code.");          public static final String NO_TRANSLATION = "NO TRANSLATION";
60                  }          public static final String DEFAULT_KEY = "default";
61            static final Logger log = Logger.getLogger(Translation.class);
62                  Locale newLocale = new Locale(activeLang);          static String activeLang = Locale.getDefault().getLanguage();
63                  Locale.setDefault(newLocale);  
64                            static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();
65                  /**  
66                   * Setting default locale for Swing JComponents to work around bug          static {
67                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480  
68                   */                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
69                  JComponent.setDefaultLocale(newLocale);                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
70                    
71                  Translation.activeLang = activeLang;                  // Get default locale
72                                    Locale locale = Locale.getDefault();
73                  fireChangeEvents();                  setActiveLang(locale.getLanguage());
74                            }
75                  log.info("skrueger.i8n.Translation switched ActiveLang to "+activeLang);  
76          }          private List<ActionListener> actionListeners = new ArrayList<ActionListener>();
77    
78          /**          @Override
79           * Initializes a new {@link Translation} with a default translation.          /*
80           * Other translations may be added later.           * @comment To make a copy of a translation see methods toOneLine() and
81           *           * fromOneLine()
82           * @param defaultTranslation           */
83           *          public Translation clone() {
84           * @deprecated SK: The concept of the default translation doesn't seem so nice to me anymore..                  throw new RuntimeException("use copy()");
85           * I would prefer the default translation to be set for all valid languages.  //              return (Translation) super.clone();
86           *          }
87           * @see public Translation(List<String> languages, String defaultTranslation) {  
88           *          /**
89           */           * Get the two-letter language sting that is active
90          public Translation(String defaultTranslation) {           */
91                  put(DEFAULT_KEY, defaultTranslation);          public static String getActiveLang() {
92          }                  return activeLang;
93            }
94          /**  
95           * Initializes a new {@link Translation}, an uses the given String to          /**
96           * initialize the {@link Translation} for all languages codes passed.           * Set up the {@link Translation}-system to use language. If a change is
97           *           * performed, events are fired to listeners. Nothing is done if the new
98           * The translations can be changed later           * language equals the old language. The system's default locale is changed.
99           */           *
100          public Translation(List<String> languages, String defaultTranslation) {           * @param newLang
101                  // put(DEFAULT_KEY, defaultTranslation);           *            The ISO Code of the new active language
102                  if (languages == null) {           */
103                          put(DEFAULT_KEY, defaultTranslation);          public static void setActiveLang(String newLang) {
104                  }                  setActiveLang(newLang, true);
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.
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          }           * @param setDefaultLocale
116             *            Shall the system's default locale be changed?
117          /**           */
118           * Fills the {@link Translation} with the values coded into the String          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
119           * Format of {@link String} is: "de{Baum}en{tree}"                  if (getActiveLang().equals(newLang)) {
120           * <p>                          return;
121           * <ul>                  }
122           * <li> If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.  
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 (!I8NUtil.isValidISOLangCode(newLang)) {
124           *                          throw new IllegalArgumentException("'" + newLang
125           * @author Stefan Alfons Krüger                                          + "' is not a valid ISO language code.");
126           */                  }
127          public void fromOneLine( final String oneLineCoded) {  
128                  clear();                  Locale newLocale = new Locale(newLang);
129                  if ( (oneLineCoded == null) || (oneLineCoded.equals("")) ) {                  if (setDefaultLocale)
130                          put(DEFAULT_KEY,NO_TRANSLATION);                          Locale.setDefault(newLocale);
131                          return;  
132                  }                  /**
133                     * Setting default locale for Swing JComponents to work around bug
134                  if (oneLineCoded.indexOf("}") == -1) {                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
135                  //      log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");                   */
136                          put(DEFAULT_KEY,oneLineCoded);                  JComponent.setDefaultLocale(newLocale);
137                  }  
138                    Translation.activeLang = newLang;
139                  String eatUp = oneLineCoded;  
140                  while ( eatUp.indexOf("}") != -1) {                  fireLocaleChangeEvents();
141                          String substring = eatUp.substring(0, eatUp.indexOf("}"));  
142                    log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
143  //                      log.debug("substring = "+substring);          }
144                          String key   = substring.substring(0, substring.indexOf("{") );  
145                          String value = substring.substring(substring.indexOf("{")+1, substring.length() );          /**
146  //                      log.debug("key="+key);           * Initializes a new {@link Translation} with a default translation if a
147  //                      log.debug("value="+value);           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
148                          put(key,value);           * Other translations may be added later - this is a HashMap<br/>
149                          eatUp = eatUp.substring(eatUp.indexOf("}")+1);           *
150                  }           * @param defaultTranslation
151          }           *
152             * @see public Translation(List<String> languages, String
153          /**           *      defaultTranslation) {
154           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"           *
155           * @author Stefan Alfons Krüger           */
156           */          public Translation(String defaultTranslation) {
157          public String toOneLine(){  
158                  StringBuffer oneLine = new StringBuffer();                  fromOneLine(defaultTranslation);
159                  for (String key: keySet()) {  
160                          oneLine.append(key+"{"+ get(key) + "}");          }
161                  }  
162                  return oneLine.toString();          /**
163          }           * Initializes a new {@link Translation}, an uses the given String to
164             * initialize the {@link Translation} for all languages codes passed.
165          /**           *
166           * Returns the right translation by using the {@link #activeLang} field.           * The translations can be changed later
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          public Translation(List<String> languages, String defaultTranslation) {
169           *  more than an empty string.                  // put(DEFAULT_KEY, defaultTranslation);
170           */                  if (languages == null) {
171          @Override                          put(DEFAULT_KEY, defaultTranslation);
172          public String toString(){                  } else
173                  if ( get(activeLang) != null ) {                          for (String code : languages) {
174                          return get(activeLang);                                  if (code.equals(getActiveLang())) {
175                  }                                          put(code, defaultTranslation);
176                  //****************************************************************************                                  }
177                  // MS: The ISDSS needs the concept of the default lang!! So I took the                          }
178                  //     following in again!!          }
179                  //****************************************************************************  
180  //              else return "";          /**
181  //              //****************************************************************************           * Sometimes Translations are optional, like for keywords.
182  //              // The following is commented out.. the concept of the default lang seems to be bad....           */
183  //              //****************************************************************************          public Translation() {
184                  // MS:          }
185                  else {  
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.");           * Fills the {@link Translation} with the values coded into the String
188                                  return get(DEFAULT_KEY);           * Format of {@link String} is: "de{Baum}en{tree}"
189                          }           * <p>
190             * <ul>
191                          // log.debug("return first best <> '' ");           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
192                          if (size() > 0)           * <li>If format can't be recognized, the {@link String} is interpreted as
193                                  for ( String s : values() ) {           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
194                                          if ( (s != null) && (s.trim().length()>0) )           *
195                                                  return s;           * @author Stefan Alfons Krüger
196                                  }           */
197                  }          public void fromOneLine(final String oneLineCoded) {
198                  log.warn("No translation found!");  
199                  return NO_TRANSLATION;                  clear();
200          }                  
201                    try {
202          /**                          
203           * Copy this {@link Translation} to another {@link Translation}                  if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
204           * e.g. for editing                          put(DEFAULT_KEY, "");
205           *                          return;
206           * @return the destination {@link Translation}                  }
207           */  
208          public Translation copy(Translation backup) {                  if (oneLineCoded.indexOf("}") == -1) {
209                  if (backup == null) throw new IllegalArgumentException("Target translation may not be null.");                          // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
210                  for (String s : keySet() ) {                          put(DEFAULT_KEY, oneLineCoded);
211                          backup.put(s, get(s) );                  }
212                  }  
213                  return backup;                  String eatUp = oneLineCoded;
214          }                  while (eatUp.indexOf("}") != -1) {
215                                    String substring = eatUp.substring(0, eatUp.indexOf("}"));
216            
217          /**                          // log.debug("substring = "+substring);
218           * {@link PropertyChangeListener} can be registered to be informed when the                          String key = substring.substring(0, substring.indexOf("{"));
219           * {@link Locale} changed.                          String value = substring.substring(substring.indexOf("{") + 1,
220           *                                          substring.length());
221           * @param propertyChangeListener                          // log.debug("key="+key);
222           */                          // log.debug("value="+value);
223          public static void addLocaleChangeListener(PropertyChangeListener propertyChangeListener) {                          put(key, value);
224                  listeners.add(propertyChangeListener);                          eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
225          }                  }
226                    } catch (Exception e) {
227          /**                          log.warn("Error while reading the oneLineCode '"+oneLineCoded+"'", e);
228           * Informs all registered {@link PropertyChangeListener}s about a change of the                          log.warn("Translation will be empty!");
229           * the {@link Locale}.                    }
230           */          }
231          public static void fireChangeEvents() {  
232                  PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,          /**
233                                  null, getActiveLang());           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
234                  for (PropertyChangeListener pcl : listeners) {           *
235                          if (pcl != null)           * @author Stefan Alfons Krüger
236                                  pcl.propertyChange(pce);           */
237                  }          public String toOneLine() {
238          }                  return I8NUtil.toOneLine(this);
239            }
240    
241  }          /**
242             * Returns the right translation by using the {@link #activeLang} field. If
243             * no translation is set, an ugly String {@link #NO_TRANSLATION} will re
244             * returned. This might be changed for the final release. If the correct
245             * language was not found, any entry in the {@link Translation}
246             * {@link HashMap} will be returned, that contains more than an empty
247             * string.
248             */
249            @Override
250            public String toString() {
251                    if (get(activeLang) != null) {
252                            return get(activeLang);
253                    }
254                    // ****************************************************************************
255                    // MS: The ISDSS needs the concept of the default lang!! So I took the
256                    // following in again!!
257                    // ****************************************************************************
258                    // else return "";
259                    // //****************************************************************************
260                    // // The following is commented out.. the concept of the default lang
261                    // seems to be bad....
262                    // //****************************************************************************
263                    // MS:
264                    else {
265                            if (get(DEFAULT_KEY) != null) {
266                                    return get(DEFAULT_KEY);
267                            }
268    
269                            // log.debug("return first best <> '' ");
270                            if (size() > 0)
271                                    for (String s : values()) {
272                                            if ((s != null) && (s.trim().length() > 0))
273                                                    return s;
274                                    }
275                    }
276    //              log.warn("No translation found!");
277                    return NO_TRANSLATION;
278            }
279    
280    
281            /**
282             * {@link PropertyChangeListener} can be registered to be informed when the
283             * {@link Locale} changed.
284             *
285             * @param propertyChangeListener
286             */
287            public static void addLocaleChangeListener(
288                            PropertyChangeListener propertyChangeListener) {
289                    listeners.add(propertyChangeListener);
290            }
291    
292            /**
293             * Informs all registered {@link PropertyChangeListener}s about a change of
294             * the the {@link Locale}.
295             */
296            public static void fireLocaleChangeEvents() {
297                    PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
298                                    new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,
299                                    null, getActiveLang());
300                    for (PropertyChangeListener pcl : listeners) {
301                            if (pcl != null)
302                                    pcl.propertyChange(pce);
303                    }
304            }
305    
306            public void addTranslationChangeListener(ActionListener actionListener) {
307                    actionListeners.add(actionListener);
308            }
309            
310            public boolean removeTranslationChangeListener(ActionListener actionListener) {
311                    return actionListeners.remove(actionListener);
312            }
313    
314            public void fireTranslationChangedEvents(String lang) {
315                    ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);
316                    
317                    for (ActionListener al : actionListeners) {
318                            al.actionPerformed( ae);
319                    }
320            }
321            
322            @Override
323            public String put(String lang, String value) {
324                    String result = super.put(lang, value);
325                    fireTranslationChangedEvents(lang);
326                    return result;
327            }
328    
329            public void fromOneLine(InternationalString iString) {
330                    if (iString != null)
331                            fromOneLine(iString.toString());
332                    else
333                            fromOneLine((String)null);
334            }
335            
336            /**
337             * Copy this {@link Translation} to another {@link Translation} e.g. for
338             * editing
339             *
340             * @return the destination {@link Translation}
341             */
342            @Override
343            public Translation copyTo(Translation translation2) {
344                    
345                    if (translation2 == null)
346                            throw new IllegalArgumentException(
347                                            "Target translation may not be null.");
348                    for (String s : keySet()) {
349                            translation2.put(s, get(s));
350                    }
351                    
352                    return translation2;
353            }
354            
355    
356            @Override
357            public Translation copy() {
358                    return copyTo(new Translation());
359            }
360    
361            /**
362             * Checks if the {@link String}s stored in the {@link Translation} are all valid.
363             * @return <code>true</code> if all good
364             */
365            public static boolean checkValid(Translation translationToCheck) {
366                    
367                    for (String l : translationToCheck.values()) {
368                            
369                            if (l.contains("{") || l.contains("}")) {
370                    
371                                    return false;
372                            }
373                    }
374                    return true;
375            }
376            
377            
378    }
Legend:
Removed from v.34  
changed lines
  Added in v.420
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26