/[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 2 by mojays, Tue Feb 24 22:43:52 2009 UTC branches/1.0-gt2-2.6/src/skrueger/i8n/Translation.java revision 315 by mojays, Wed Aug 26 11:03:27 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 org.apache.log4j.Logger;   * and the Geotools library.
7     *
8  /**   * The SCHMITZM project is hosted at:
9   * Represents a {@link HashMap} of translations.   * http://wald.intevation.org/projects/schmitzm/
10   * toString() returns the appropriate translation   *
11   *   * This program is free software; you can redistribute it and/or
12   * @author @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>   * modify it under the terms of the GNU Lesser General Public License
13   */   * as published by the Free Software Foundation; either version 3
14     * of the License, or (at your option) any later version.
15  public class Translation extends HashMap<String, String> {   *
16          public static final String NO_TRANSLATION = "NO TRANSLATION";   * This program is distributed in the hope that it will be useful,
17          public static final String DEFAULT_KEY = "default";   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18          static final Logger log = Logger.getLogger( Translation.class );   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19          static String activeLang = "fr";   * GNU General Public License for more details.
20     *
21          static {   * You should have received a copy of the GNU Lesser General Public License (license.txt)
22                     * along with this program; if not, write to the Free Software
23                  //TODO default aus Locale auslesen und mit möglichen vergleichen... mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24     * or try this link: http://www.gnu.org/licenses/lgpl.html
25                    // Get default locale   *
26              Locale locale = Locale.getDefault();   * Contributors:
27                  setActiveLang(locale.getLanguage());   *     Martin O. J. Schmitz - initial API and implementation
28          }   *     Stefan A. Krüger - additional utility classes
29             ******************************************************************************/
30          @Override  package skrueger.i8n;
31          public Translation clone() {  
32                  return (Translation) super.clone();  import java.awt.event.ActionEvent;
33          }  import java.awt.event.ActionListener;
34    import java.beans.PropertyChangeEvent;
35          /**  import java.beans.PropertyChangeListener;
36           * Get the two-letter language sting that is active  import java.util.ArrayList;
37           */  import java.util.HashMap;
38          public static String getActiveLang() {  import java.util.List;
39                  return activeLang;  import java.util.Locale;
40          }  import java.util.Random;
41    
42          /**  import javax.swing.JComponent;
43           * Set up the {@link Translation}-system to use language.  
44           * @param activeLang  import org.apache.log4j.Logger;
45           */  
46          public static void setActiveLang(String activeLang) {  /**
47                  if (!I8NUtil.isValidISOLangCode(activeLang)) {   * Represents a {@link HashMap} of translations. toString() returns the
48                          throw new IllegalArgumentException("'"+activeLang+"' is not a valid ISO language code.");   * appropriate translation
49                  }   *
50     * @author @author <a href="mailto:[email protected]">Stefan Alfons
51                  Locale.setDefault(new Locale(activeLang));   *         Kr&uuml;ger</a>
52                  Translation.activeLang = activeLang;   */
53                  log.info("Translation-system switched to "+activeLang);  
54          }  public class Translation extends HashMap<String, String> {
55            public static final String LOCALECHANGE_PROPERTY = "localechange";
56          /**          public static final String NO_TRANSLATION = "NO TRANSLATION";
57           * Initilises a new {@link Translation} with a default translation.          public static final String DEFAULT_KEY = "default";
58           * Other translations may be added later.          static final Logger log = Logger.getLogger(Translation.class);
59           *          static String activeLang = Locale.getDefault().getLanguage();
60           * @param defaultTranslation  
61           *          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();
62           * @deprecated SK: The concept of the default translation doesn't seem so nice to me anymore..  
63           * I would prefer the default translation to be set for all valid languages.          static {
64           *  
65           * @see public Translation(List<String> languages, String defaultTranslation) {                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
66           *                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
67           */  
68          public Translation(String defaultTranslation) {                  // Get default locale
69                  put(DEFAULT_KEY, defaultTranslation);                  Locale locale = Locale.getDefault();
70          }                  setActiveLang(locale.getLanguage());
71            }
72          /**  
73           * Initilises a new {@link Translation}, an uses the given String to          private List<ActionListener> actionListeners = new ArrayList<ActionListener>();
74           * initialise the {@link Translation} for all languages codes passed.  
75           *          @Override
76           * The translations can be cahnged later          /*
77           */           * @comment To make a copy of a translation see methods toOneLine() and
78          public Translation(List<String> languages, String defaultTranslation) {           * fromOneLine()
79                  // put(DEFAULT_KEY, defaultTranslation);           */
80                  if (languages == null) {          public Translation clone() {
81                          put(DEFAULT_KEY, defaultTranslation);                  return (Translation) super.clone();
82                  }          }
83                  else for (String code : languages){  
84                          put(code, defaultTranslation);          /**
85                  }           * Get the two-letter language sting that is active
86          }           */
87            public static String getActiveLang() {
88          /**                  return activeLang;
89           * Sometimes Translations are optional, like for keywords.          }
90           */  
91          public Translation() {          /**
92                  super();           * Set up the {@link Translation}-system to use language. If a change is
93          }           * performed, events are fired to listeners. Nothing is done if the new
94             * language equals the old language. The system's default locale is changed.
95          /**           *
96           * Fills the {@link Translation} with the values coded into the String           * @param newLang
97           * Format of {@link String} is: "de{Baum}en{tree}"           *            The ISO Code of the new active language
98           * <p>           */
99           * <ul>          public static void setActiveLang(String newLang) {
100           * <li> If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.                  setActiveLang(newLang, true);
101           * <li> If format can't be recognized, the {@link String} is interpreted as the translation in the <code>{@value #DEFAULT_KEY}</code> language          }
102           *  
103           * @author Stefan Alfons Krüger          /**
104           */           * Set up the {@link Translation}-system to use language. If a change is
105          public void fromOneLine( final String oneLineCoded) {           * performed, events are fired to listeners. Nothing is done if the new
106                  clear();           * language equals the old language.
107                  if ( (oneLineCoded == null) || (oneLineCoded.equals("")) ) {           *
108                          put(DEFAULT_KEY,NO_TRANSLATION);           * @param newLang
109                          return;           *            The ISO Code of the new active language
110                  }           *
111             * @param setDefaultLocale
112                  if (oneLineCoded.indexOf("}") == -1) {           *            Shall the system's default locale be changed?
113                  //      log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");           */
114                          put(DEFAULT_KEY,oneLineCoded);          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
115                  }                  if (getActiveLang().equals(newLang)) {
116                            return;
117                  String eatUp = oneLineCoded;                  }
118                  while ( eatUp.indexOf("}") != -1) {  
119                          String substring = eatUp.substring(0, eatUp.indexOf("}"));                  if (!I8NUtil.isValidISOLangCode(newLang)) {
120                            throw new IllegalArgumentException("'" + newLang
121  //                      log.debug("substring = "+substring);                                          + "' is not a valid ISO language code.");
122                          String key   = substring.substring(0, substring.indexOf("{") );                  }
123                          String value = substring.substring(substring.indexOf("{")+1, substring.length() );  
124  //                      log.debug("key="+key);                  Locale newLocale = new Locale(newLang);
125  //                      log.debug("value="+value);                  if (setDefaultLocale)
126                          put(key,value);                          Locale.setDefault(newLocale);
127                          eatUp = eatUp.substring(eatUp.indexOf("}")+1);  
128                  }                  /**
129          }                   * Setting default locale for Swing JComponents to work around bug
130                     * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
131          /**                   */
132           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"                  JComponent.setDefaultLocale(newLocale);
133           * @author Stefan Alfons Krüger  
134           */                  Translation.activeLang = newLang;
135          public String toOneLine(){  
136                  StringBuffer oneLine = new StringBuffer();                  fireLocaleChangeEvents();
137                  for (String key: keySet()) {  
138                          oneLine.append(key+"{"+ get(key) + "}");                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
139                  }          }
140                  return oneLine.toString();  
141          }          /**
142             * Initializes a new {@link Translation} with a default translation if a
143          /**           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
144           * Returns the right translation by using the {@link #activeLang} field.           * Other translations may be added later - this is a HashMap<br/>
145           * If no translation is set, an ugly String {@link #NO_TRANSLATION} will re returned. This might be changed for the final release.           *
146           * If the correct language was not found, any entry in the {@link Translation} {@link HashMap} will be returned, that contains           * @param defaultTranslation
147           *  more than an empty string.           *
148           */           * @see public Translation(List<String> languages, String
149          @Override           *      defaultTranslation) {
150          public String toString(){           *
151                  if ( get(activeLang) != null ) {           */
152                          return get(activeLang);          public Translation(String defaultTranslation) {
153                  }  
154                  //****************************************************************************                  fromOneLine(defaultTranslation);
155                  // MS: The ISDSS needs the concept of the default lang!! So I took the  
156                  //     following in again!!          }
157                  //****************************************************************************  
158  //              else return "";          /**
159  //              //****************************************************************************           * Initializes a new {@link Translation}, an uses the given String to
160  //              // The following is commented out.. the concept of the default lang seems to be bad....           * initialize the {@link Translation} for all languages codes passed.
161  //              //****************************************************************************           *
162                  // MS:           * The translations can be changed later
163                  else {           */
164                          if ( get(DEFAULT_KEY) != null ) {          public Translation(List<String> languages, String defaultTranslation) {
165  //                              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.");                  // put(DEFAULT_KEY, defaultTranslation);
166                                  return get(DEFAULT_KEY);                  if (languages == null) {
167                          }                          put(DEFAULT_KEY, defaultTranslation);
168                    } else
169                          // log.debug("return first best <> '' ");                          for (String code : languages) {
170                          if (size() > 0)                                  if (code.equals(getActiveLang())) {
171                                  for ( String s : values() ) {                                          put(code, defaultTranslation);
172                                          if ( (s != null) && (s.trim().length()>0) )                                  }
173                                                  return s;                          }
174                                  }          }
175                  }  
176                  log.warn("No translation found!");          /**
177                  return NO_TRANSLATION;           * Sometimes Translations are optional, like for keywords.
178          }           */
179            public Translation() {
180          /**          }
181           * Copy this {@link Translation} to another {@link Translation}  
182           * e.g. for editing          /**
183           *           * Fills the {@link Translation} with the values coded into the String
184           * @return the destination {@link Translation}           * Format of {@link String} is: "de{Baum}en{tree}"
185           */           * <p>
186          public Translation copy(Translation backup) {           * <ul>
187                  if (backup == null) throw new IllegalArgumentException("Target translation may not be null.");           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
188                  for (String s : keySet() ) {           * <li>If format can't be recognized, the {@link String} is interpreted as
189                          backup.put(s, get(s) );           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
190                  }           *
191                  return backup;           * @author Stefan Alfons Krüger
192          }           */
193            public void fromOneLine(final String oneLineCoded) {
194  }                  clear();
195                    if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
196                            put(DEFAULT_KEY, "");
197                            return;
198                    }
199    
200                    if (oneLineCoded.indexOf("}") == -1) {
201                            // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
202                            put(DEFAULT_KEY, oneLineCoded);
203                    }
204    
205                    String eatUp = oneLineCoded;
206                    while (eatUp.indexOf("}") != -1) {
207                            String substring = eatUp.substring(0, eatUp.indexOf("}"));
208    
209                            // log.debug("substring = "+substring);
210                            String key = substring.substring(0, substring.indexOf("{"));
211                            String value = substring.substring(substring.indexOf("{") + 1,
212                                            substring.length());
213                            // log.debug("key="+key);
214                            // log.debug("value="+value);
215                            put(key, value);
216                            eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
217                    }
218            }
219    
220            /**
221             * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
222             *
223             * @author Stefan Alfons Krüger
224             */
225            public String toOneLine() {
226                    return I8NUtil.toOneLine(this);
227            }
228    
229            /**
230             * Returns the right translation by using the {@link #activeLang} field. If
231             * no translation is set, an ugly String {@link #NO_TRANSLATION} will re
232             * returned. This might be changed for the final release. If the correct
233             * language was not found, any entry in the {@link Translation}
234             * {@link HashMap} will be returned, that contains more than an empty
235             * string.
236             */
237            @Override
238            public String toString() {
239                    if (get(activeLang) != null) {
240                            return get(activeLang);
241                    }
242                    // ****************************************************************************
243                    // MS: The ISDSS needs the concept of the default lang!! So I took the
244                    // following in again!!
245                    // ****************************************************************************
246                    // else return "";
247                    // //****************************************************************************
248                    // // The following is commented out.. the concept of the default lang
249                    // seems to be bad....
250                    // //****************************************************************************
251                    // MS:
252                    else {
253                            if (get(DEFAULT_KEY) != null) {
254                                    // 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.");
255                                    return get(DEFAULT_KEY);
256                            }
257    
258                            // log.debug("return first best <> '' ");
259                            if (size() > 0)
260                                    for (String s : values()) {
261                                            if ((s != null) && (s.trim().length() > 0))
262                                                    return s;
263                                    }
264                    }
265    //              log.warn("No translation found!");
266                    return NO_TRANSLATION;
267            }
268    
269            /**
270             * Copy this {@link Translation} to another {@link Translation} e.g. for
271             * editing
272             *
273             * @return the destination {@link Translation}
274             */
275            public Translation copy(Translation backup) {
276                    if (backup == null)
277                            throw new IllegalArgumentException(
278                                            "Target translation may not be null.");
279                    for (String s : keySet()) {
280                            backup.put(s, get(s));
281                    }
282                    return backup;
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            public void addTranslationChangeListener(ActionListener actionListener) {
311                    actionListeners.add(actionListener);
312            }
313            
314            public boolean removeTranslationChangeListener(ActionListener actionListener) {
315                    return actionListeners.remove(actionListener);
316            }
317    
318            public void fireTranslationChangedEvents(String lang) {
319                    ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);
320                    
321                    for (ActionListener al : actionListeners) {
322                            al.actionPerformed( ae);
323                    }
324            }
325            
326            @Override
327            public String put(String lang, String value) {
328                    String result = super.put(lang, value);
329                    fireTranslationChangedEvents(lang);
330                    return result;
331            }
332            
333            
334    }
Legend:
Removed from v.2  
changed lines
  Added in v.315
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26