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