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