/[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

revision 38 by alfonx, Sun Apr 5 15:06:56 2009 UTC revision 300 by alfonx, Sat Aug 15 10:33:43 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    
46          /**  /**
47           * Get the two-letter language sting that is active   * Represents a {@link HashMap} of translations. toString() returns the
48           */   * appropriate translation
49          public static String getActiveLang() {   *
50                  return activeLang;   * @author @author <a href="mailto:[email protected]">Stefan Alfons
51          }   *         Kr&uuml;ger</a>
52     */
53          /**  
54           * Set up the {@link Translation}-system to use language. If a change is performed, events are fired to listeners. Nothing is done if the new language equals the old language.  public class Translation extends HashMap<String, String> {
55           *          public static final String LOCALECHANGE_PROPERTY = "localechange";
56           * @param newLang The ISO Code of the new active language          public static final String NO_TRANSLATION = "NO TRANSLATION";
57           */          public static final String DEFAULT_KEY = "default";
58          public static void setActiveLang(String newLang) {          static final Logger log = Logger.getLogger(Translation.class);
59                  if (getActiveLang().equals(newLang)) {          static String activeLang = Locale.getDefault().getLanguage();
60                          return;  
61                  }          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();
62                    
63                  if (!I8NUtil.isValidISOLangCode(newLang)) {          static {
64                          throw new IllegalArgumentException("'"+newLang+"' is not a valid ISO language code.");  
65                  }                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
66                    // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
67                  Locale newLocale = new Locale(newLang);  
68                  Locale.setDefault(newLocale);                  // Get default locale
69                                    Locale locale = Locale.getDefault();
70                  /**                  setActiveLang(locale.getLanguage());
71                   * Setting default locale for Swing JComponents to work around bug          }
72                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480  
73                   */          private List<ActionListener> actionListeners = new ArrayList<ActionListener>();
74                  JComponent.setDefaultLocale(newLocale);  
75                            @Override
76                  Translation.activeLang = newLang;          /*
77                             * @comment To make a copy of a translation see methods toOneLine() and
78                  fireChangeEvents();           * fromOneLine()
79                             */
80                  log.info("skrueger.i8n.Translation switched ActiveLang to "+newLang);          public Translation clone() {
81          }                  return (Translation) super.clone();
82            }
83          /**  
84           * Initializes a new {@link Translation} with a default translation.          /**
85           * Other translations may be added later.           * Get the two-letter language sting that is active
86           *           */
87           * @param defaultTranslation          public static String getActiveLang() {
88           *                  return activeLang;
89           * @deprecated SK: The concept of the default translation doesn't seem so nice to me anymore..          }
90           * I would prefer the default translation to be set for all valid languages.  
91           *          /**
92           * @see public Translation(List<String> languages, String defaultTranslation) {           * 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          public Translation(String defaultTranslation) {           *
96                  put(DEFAULT_KEY, defaultTranslation);           * @param newLang
97          }           *            The ISO Code of the new active language
98             */
99          /**          public static void setActiveLang(String newLang) {
100           * Initializes a new {@link Translation}, an uses the given String to                  setActiveLang(newLang, true);
101           * initialize the {@link Translation} for all languages codes passed.          }
102           *  
103           * The translations can be changed later          /**
104           */           * Set up the {@link Translation}-system to use language. If a change is
105          public Translation(List<String> languages, String defaultTranslation) {           * performed, events are fired to listeners. Nothing is done if the new
106                  // put(DEFAULT_KEY, defaultTranslation);           * language equals the old language.
107                  if (languages == null) {           *
108                          put(DEFAULT_KEY, defaultTranslation);           * @param newLang
109                  }           *            The ISO Code of the new active language
110                  else for (String code : languages){           *
111                          if (code.equals(getActiveLang())) {           * @param setDefaultLocale
112                                  put(code, defaultTranslation);           *            Shall the system's default locale be changed?
113                          }           */
114                  }          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
115          }                  if (getActiveLang().equals(newLang)) {
116                            return;
117          /**                  }
118           * Sometimes Translations are optional, like for keywords.  
119           */                  if (!I8NUtil.isValidISOLangCode(newLang)) {
120          public Translation() {                          throw new IllegalArgumentException("'" + newLang
121                  super();                                          + "' is not a valid ISO language code.");
122          }                  }
123    
124          /**                  Locale newLocale = new Locale(newLang);
125           * Fills the {@link Translation} with the values coded into the String                  if (setDefaultLocale)
126           * Format of {@link String} is: "de{Baum}en{tree}"                          Locale.setDefault(newLocale);
127           * <p>  
128           * <ul>                  /**
129           * <li> If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.                   * Setting default locale for Swing JComponents to work around bug
130           * <li> If format can't be recognized, the {@link String} is interpreted as the translation in the <code>{@value #DEFAULT_KEY}</code> language                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
131           *                   */
132           * @author Stefan Alfons Krüger                  JComponent.setDefaultLocale(newLocale);
133           */  
134          public void fromOneLine( final String oneLineCoded) {                  Translation.activeLang = newLang;
135                  clear();  
136                  if ( (oneLineCoded == null) || (oneLineCoded.equals("")) ) {                  fireLocaleChangeEvents();
137                          put(DEFAULT_KEY,NO_TRANSLATION);  
138                          return;                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
139                  }          }
140    
141                  if (oneLineCoded.indexOf("}") == -1) {          /**
142                  //      log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");           * Initializes a new {@link Translation} with a default translation if a
143                          put(DEFAULT_KEY,oneLineCoded);           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
144                  }           * Other translations may be added later - this is a HashMap<br/>
145             *
146                  String eatUp = oneLineCoded;           * @param defaultTranslation
147                  while ( eatUp.indexOf("}") != -1) {           *
148                          String substring = eatUp.substring(0, eatUp.indexOf("}"));           * @see public Translation(List<String> languages, String
149             *      defaultTranslation) {
150  //                      log.debug("substring = "+substring);           *
151                          String key   = substring.substring(0, substring.indexOf("{") );           */
152                          String value = substring.substring(substring.indexOf("{")+1, substring.length() );          public Translation(String defaultTranslation) {
153  //                      log.debug("key="+key);  
154  //                      log.debug("value="+value);                  fromOneLine(defaultTranslation);
155                          put(key,value);  
156                          eatUp = eatUp.substring(eatUp.indexOf("}")+1);          }
157                  }  
158          }          /**
159             * Initializes a new {@link Translation}, an uses the given String to
160          /**           * initialize the {@link Translation} for all languages codes passed.
161           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"           *
162           * @author Stefan Alfons Krüger           * The translations can be changed later
163           */           */
164          public String toOneLine(){          public Translation(List<String> languages, String defaultTranslation) {
165                  StringBuffer oneLine = new StringBuffer();                  // put(DEFAULT_KEY, defaultTranslation);
166                  for (String key: keySet()) {                  if (languages == null) {
167                          oneLine.append(key+"{"+ get(key) + "}");                          put(DEFAULT_KEY, defaultTranslation);
168                  }                  } else
169                  return oneLine.toString();                          for (String code : languages) {
170          }                                  if (code.equals(getActiveLang())) {
171                                            put(code, defaultTranslation);
172          /**                                  }
173           * Returns the right translation by using the {@link #activeLang} field.                          }
174           * If no translation is set, an ugly String {@link #NO_TRANSLATION} will re returned. This might be changed for the final release.          }
175           * If the correct language was not found, any entry in the {@link Translation} {@link HashMap} will be returned, that contains  
176           *  more than an empty string.          /**
177           */           * Sometimes Translations are optional, like for keywords.
178          @Override           */
179          public String toString(){          public Translation() {
180                  if ( get(activeLang) != null ) {          }
181                          return get(activeLang);  
182                  }          /**
183                  //****************************************************************************           * Fills the {@link Translation} with the values coded into the String
184                  // MS: The ISDSS needs the concept of the default lang!! So I took the           * Format of {@link String} is: "de{Baum}en{tree}"
185                  //     following in again!!           * <p>
186                  //****************************************************************************           * <ul>
187  //              else return "";           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
188  //              //****************************************************************************           * <li>If format can't be recognized, the {@link String} is interpreted as
189  //              // The following is commented out.. the concept of the default lang seems to be bad....           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
190  //              //****************************************************************************           *
191                  // MS:           * @author Stefan Alfons Krüger
192                  else {           */
193                          if ( get(DEFAULT_KEY) != null ) {          public void fromOneLine(final String oneLineCoded) {
194  //                              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.");                  clear();
195                                  return get(DEFAULT_KEY);                  if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
196                          }                          put(DEFAULT_KEY, "");
197                            return;
198                          // log.debug("return first best <> '' ");                  }
199                          if (size() > 0)  
200                                  for ( String s : values() ) {                  if (oneLineCoded.indexOf("}") == -1) {
201                                          if ( (s != null) && (s.trim().length()>0) )                          // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
202                                                  return s;                          put(DEFAULT_KEY, oneLineCoded);
203                                  }                  }
204                  }  
205                  log.warn("No translation found!");                  String eatUp = oneLineCoded;
206                  return NO_TRANSLATION;                  while (eatUp.indexOf("}") != -1) {
207          }                          String substring = eatUp.substring(0, eatUp.indexOf("}"));
208    
209          /**                          // log.debug("substring = "+substring);
210           * Copy this {@link Translation} to another {@link Translation}                          String key = substring.substring(0, substring.indexOf("{"));
211           * e.g. for editing                          String value = substring.substring(substring.indexOf("{") + 1,
212           *                                          substring.length());
213           * @return the destination {@link Translation}                          // log.debug("key="+key);
214           */                          // log.debug("value="+value);
215          public Translation copy(Translation backup) {                          put(key, value);
216                  if (backup == null) throw new IllegalArgumentException("Target translation may not be null.");                          eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
217                  for (String s : keySet() ) {                  }
218                          backup.put(s, get(s) );          }
219                  }  
220                  return backup;          /**
221          }           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
222                     *
223                     * @author Stefan Alfons Krüger
224          /**           */
225           * {@link PropertyChangeListener} can be registered to be informed when the          public String toOneLine() {
226           * {@link Locale} changed.                  return I8NUtil.toOneLine(this);
227           *          }
228           * @param propertyChangeListener  
229           */          /**
230          public static void addLocaleChangeListener(PropertyChangeListener propertyChangeListener) {           * Returns the right translation by using the {@link #activeLang} field. If
231                  listeners.add(propertyChangeListener);           * 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           * Informs all registered {@link PropertyChangeListener}s about a change of the           * string.
236           * the {@link Locale}.             */
237           */          @Override
238          public static void fireChangeEvents() {          public String toString() {
239                  PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,                  if (get(activeLang) != null) {
240                                  null, getActiveLang());                          return get(activeLang);
241                  for (PropertyChangeListener pcl : listeners) {                  }
242                          if (pcl != null)                  // ****************************************************************************
243                                  pcl.propertyChange(pce);                  // 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.38  
changed lines
  Added in v.300
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26