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