/[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 482 by alfonx, Tue Oct 20 13:51:11 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.Iterator;
39                  return activeLang;  import java.util.List;
40          }  import java.util.Locale;
41    import java.util.Random;
42          /**  
43           * Set up the {@link Translation}-system to use language.  import javax.swing.JComponent;
44           * @param activeLang  
45           */  import org.apache.log4j.Logger;
46          public static void setActiveLang(String activeLang) {  import org.geotools.util.WeakHashSet;
47                  if (!I8NUtil.isValidISOLangCode(activeLang)) {  import org.opengis.util.InternationalString;
48                          throw new IllegalArgumentException("'"+activeLang+"' is not a valid ISO language code.");  
49                  }  import skrueger.geotools.Copyable;
50    
51                  Locale.setDefault(new Locale(activeLang));  /**
52                  Translation.activeLang = activeLang;   * Represents a {@link HashMap} of translations. toString() returns the
53                  log.info("Translation-system switched to "+activeLang);   * appropriate translation
54          }   *
55     * @author @author <a href="mailto:[email protected]">Stefan Alfons
56          /**   *         Kr&uuml;ger</a>
57           * Initilises a new {@link Translation} with a default translation.   */
58           * Other translations may be added later.  
59           *  public class Translation extends HashMap<String, String> implements
60           * @param defaultTranslation                  Copyable<Translation> {
61           *          public static final String LOCALECHANGE_PROPERTY = "localechange";
62           * @deprecated SK: The concept of the default translation doesn't seem so nice to me anymore..          public static final String NO_TRANSLATION = "NO TRANSLATION";
63           * I would prefer the default translation to be set for all valid languages.          public static final String DEFAULT_KEY = "default";
64           *          static final Logger log = Logger.getLogger(Translation.class);
65           * @see public Translation(List<String> languages, String defaultTranslation) {          static String activeLang = Locale.getDefault().getLanguage();
66           *  
67           */          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();
68          public Translation(String defaultTranslation) {  
69                  put(DEFAULT_KEY, defaultTranslation);          static {
70          }  
71                    // TODO default aus Locale auslesen und mit möglichen vergleichen...
72          /**                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
73           * Initilises a new {@link Translation}, an uses the given String to  
74           * initialise the {@link Translation} for all languages codes passed.                  // Get default locale
75           *                  Locale locale = Locale.getDefault();
76           * The translations can be cahnged later                  setActiveLang(locale.getLanguage());
77           */          }
78          public Translation(List<String> languages, String defaultTranslation) {  
79                  // put(DEFAULT_KEY, defaultTranslation);          private WeakHashSet<ActionListener> actionListeners = new WeakHashSet<ActionListener>(
80                  if (languages == null) {                          ActionListener.class);
81                          put(DEFAULT_KEY, defaultTranslation);  
82                  }          @Override
83                  else for (String code : languages){          /*
84                          put(code, defaultTranslation);           * @comment To make a copy of a translation see methods toOneLine() and
85                  }           * fromOneLine()
86          }           */
87            public Translation clone() {
88          /**                  throw new RuntimeException("use copy()");
89           * Sometimes Translations are optional, like for keywords.                  // return (Translation) super.clone();
90           */          }
91          public Translation() {  
92                  super();          /**
93          }           * Get the two-letter language sting that is active
94             */
95          /**          public static String getActiveLang() {
96           * Fills the {@link Translation} with the values coded into the String                  return activeLang;
97           * Format of {@link String} is: "de{Baum}en{tree}"          }
98           * <p>  
99           * <ul>          /**
100           * <li> If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.           * Set up the {@link Translation}-system to use language. If a change is
101           * <li> If format can't be recognized, the {@link String} is interpreted as the translation in the <code>{@value #DEFAULT_KEY}</code> language           * performed, events are fired to listeners. Nothing is done if the new
102           *           * language equals the old language. The system's default locale is changed.
103           * @author Stefan Alfons Krüger           *
104           */           * @param newLang
105          public void fromOneLine( final String oneLineCoded) {           *            The ISO Code of the new active language
106                  clear();           */
107                  if ( (oneLineCoded == null) || (oneLineCoded.equals("")) ) {          public static void setActiveLang(String newLang) {
108                          put(DEFAULT_KEY,NO_TRANSLATION);                  setActiveLang(newLang, true);
109                          return;          }
110                  }  
111            /**
112                  if (oneLineCoded.indexOf("}") == -1) {           * Set up the {@link Translation}-system to use language. If a change is
113                  //      log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");           * performed, events are fired to listeners. Nothing is done if the new
114                          put(DEFAULT_KEY,oneLineCoded);           * language equals the old language.
115                  }           *
116             * @param newLang
117                  String eatUp = oneLineCoded;           *            The ISO Code of the new active language
118                  while ( eatUp.indexOf("}") != -1) {           *
119                          String substring = eatUp.substring(0, eatUp.indexOf("}"));           * @param setDefaultLocale
120             *            Shall the system's default locale be changed?
121  //                      log.debug("substring = "+substring);           */
122                          String key   = substring.substring(0, substring.indexOf("{") );          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
123                          String value = substring.substring(substring.indexOf("{")+1, substring.length() );                  if (getActiveLang().equals(newLang)) {
124  //                      log.debug("key="+key);                          return;
125  //                      log.debug("value="+value);                  }
126                          put(key,value);  
127                          eatUp = eatUp.substring(eatUp.indexOf("}")+1);                  if (!I8NUtil.isValidISOLangCode(newLang)) {
128                  }                          throw new IllegalArgumentException("'" + newLang
129          }                                          + "' is not a valid ISO language code.");
130                    }
131          /**  
132           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"                  Locale newLocale = new Locale(newLang);
133           * @author Stefan Alfons Krüger                  if (setDefaultLocale)
134           */                          Locale.setDefault(newLocale);
135          public String toOneLine(){  
136                  StringBuffer oneLine = new StringBuffer();                  /**
137                  for (String key: keySet()) {                   * Setting default locale for Swing JComponents to work around bug
138                          oneLine.append(key+"{"+ get(key) + "}");                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
139                  }                   */
140                  return oneLine.toString();                  JComponent.setDefaultLocale(newLocale);
141          }  
142                    Translation.activeLang = newLang;
143          /**  
144           * Returns the right translation by using the {@link #activeLang} field.                  fireLocaleChangeEvents();
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                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
147           *  more than an empty string.          }
148           */  
149          @Override          /**
150          public String toString(){           * Initializes a new {@link Translation} with a default translation if a
151                  if ( get(activeLang) != null ) {           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
152                          return get(activeLang);           * Other translations may be added later - this is a HashMap<br/>
153                  }           *
154                  //****************************************************************************           * @param defaultTranslation
155                  // MS: The ISDSS needs the concept of the default lang!! So I took the           *
156                  //     following in again!!           * @see public Translation(List<String> languages, String
157                  //****************************************************************************           *      defaultTranslation) {
158  //              else return "";           *
159  //              //****************************************************************************           */
160  //              // The following is commented out.. the concept of the default lang seems to be bad....          public Translation(String defaultTranslation) {
161  //              //****************************************************************************  
162                  // MS:                  fromOneLine(defaultTranslation);
163                  else {  
164                          if ( get(DEFAULT_KEY) != null ) {          }
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.");  
166                                  return get(DEFAULT_KEY);          /**
167                          }           * Initializes a new {@link Translation}, an uses the given String to
168             * initialize the {@link Translation} for all languages codes passed.
169                          // log.debug("return first best <> '' ");           *
170                          if (size() > 0)           * The translations can be changed later
171                                  for ( String s : values() ) {           */
172                                          if ( (s != null) && (s.trim().length()>0) )          public Translation(List<String> languages, String defaultTranslation) {
173                                                  return s;                  // put(DEFAULT_KEY, defaultTranslation);
174                                  }                  if (languages == null) {
175                  }                          put(DEFAULT_KEY, defaultTranslation);
176                  log.warn("No translation found!");                  } else
177                  return NO_TRANSLATION;                          for (String code : languages) {
178          }                                  if (code.equals(getActiveLang())) {
179                                            put(code, defaultTranslation);
180          /**                                  }
181           * Copy this {@link Translation} to another {@link Translation}                          }
182           * e.g. for editing          }
183           *  
184           * @return the destination {@link Translation}          /**
185           */           * Sometimes Translations are optional, like for keywords.
186          public Translation copy(Translation backup) {           */
187                  if (backup == null) throw new IllegalArgumentException("Target translation may not be null.");          public Translation() {
188                  for (String s : keySet() ) {          }
189                          backup.put(s, get(s) );  
190                  }          /**
191                  return backup;           * Fills the {@link Translation} with the values coded into the String
192          }           * Format of {@link String} is: "de{Baum}en{tree}"
193             * <p>
194  }           * <ul>
195             * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
196             * <li>If format can't be recognized, the {@link String} is interpreted as
197             * the translation in the <code>{@value #DEFAULT_KEY}</code> language
198             *
199             * @author Stefan Alfons Krüger
200             */
201            public void fromOneLine(final String oneLineCoded) {
202    
203                    clear();
204    
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                            log.warn("Error while reading the oneLineCode '" + oneLineCoded
232                                            + "'", e);
233                            log.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                    actionListeners.add(actionListener);
316            }
317    
318            /**
319             * The listeneras are stored in a {@link WeakHashSet}! You don't have to
320             * remove the listener, as long as you throw away the reference to the
321             * listener.
322             */
323            public boolean removeTranslationChangeListener(ActionListener actionListener) {
324                    return actionListeners.remove(actionListener);
325            }
326    
327            public void fireTranslationChangedEvents(String lang) {
328                    ActionEvent ae = new ActionEvent(this, new Random().nextInt(), lang);
329    
330                    final Iterator<ActionListener> iterator = actionListeners.iterator();
331                    while (iterator.hasNext()) {
332                            ActionListener al = iterator.next();
333                            al.actionPerformed(ae);
334                    }
335            }
336    
337            @Override
338            public String put(String lang, String value) {
339                    String result = super.put(lang, value);
340                    fireTranslationChangedEvents(lang);
341                    return result;
342            }
343    
344            public void fromOneLine(InternationalString iString) {
345                    if (iString != null)
346                            fromOneLine(iString.toString());
347                    else
348                            fromOneLine((String) null);
349            }
350    
351            /**
352             * Copy this {@link Translation} to another {@link Translation} e.g. for
353             * editing
354             *
355             * @return the destination {@link Translation}
356             */
357            @Override
358            public Translation copyTo(Translation translation2) {
359    
360                    if (translation2 == null)
361                            // throw new IllegalArgumentException(
362                            // "Target translation may not be null.");
363                            return copy();
364                    for (String s : keySet()) {
365                            translation2.put(s, get(s));
366                    }
367    
368                    return translation2;
369            }
370    
371            @Override
372            public Translation copy() {
373                    return copyTo(new Translation());
374            }
375    
376            /**
377             * Checks if the {@link String}s stored in the {@link Translation} are all
378             * valid.
379             *
380             * @return <code>true</code> if all good
381             */
382            public static boolean checkValid(Translation translationToCheck) {
383    
384                    for (String l : translationToCheck.values()) {
385    
386                            if (l.contains("{") || l.contains("}")) {
387    
388                                    return false;
389                            }
390                    }
391                    return true;
392            }
393    
394    }
Legend:
Removed from v.2  
changed lines
  Added in v.482
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26