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