/[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 2 by mojays, Tue Feb 24 22:43:52 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.util.HashMap;   * Copyright (c) 2009 Martin O. J. Schmitz.
3  import java.util.List;   *
4  import java.util.Locale;   * This file is part of the SCHMITZM library - a collection of utility
5     * classes based on Java 1.6, focusing (not only) on Java Swing
6  import org.apache.log4j.Logger;   * and the Geotools library.
7     *
8  /**   * The SCHMITZM project is hosted at:
9   * Represents a {@link HashMap} of translations.   * http://wald.intevation.org/projects/schmitzm/
10   * toString() returns the appropriate translation   *
11   *   * This program is free software; you can redistribute it and/or
12   * @author @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>   * modify it under the terms of the GNU Lesser General Public License
13   */   * as published by the Free Software Foundation; either version 3
14     * of the License, or (at your option) any later version.
15  public class Translation extends HashMap<String, String> {   *
16          public static final String NO_TRANSLATION = "NO TRANSLATION";   * This program is distributed in the hope that it will be useful,
17          public static final String DEFAULT_KEY = "default";   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18          static final Logger log = Logger.getLogger( Translation.class );   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19          static String activeLang = "fr";   * GNU General Public License for more details.
20     *
21          static {   * You should have received a copy of the GNU Lesser General Public License (license.txt)
22                     * along with this program; if not, write to the Free Software
23                  //TODO default aus Locale auslesen und mit möglichen vergleichen... mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24     * or try this link: http://www.gnu.org/licenses/lgpl.html
25                    // Get default locale   *
26              Locale locale = Locale.getDefault();   * Contributors:
27                  setActiveLang(locale.getLanguage());   *     Martin O. J. Schmitz - initial API and implementation
28          }   *     Stefan A. Krüger - additional utility classes
29             ******************************************************************************/
30          @Override  package skrueger.i8n;
31          public Translation clone() {  
32                  return (Translation) super.clone();  import java.beans.PropertyChangeEvent;
33          }  import java.beans.PropertyChangeListener;
34    import java.util.ArrayList;
35          /**  import java.util.HashMap;
36           * Get the two-letter language sting that is active  import java.util.List;
37           */  import java.util.Locale;
38          public static String getActiveLang() {  
39                  return activeLang;  import javax.swing.JComponent;
40          }  
41    import org.apache.log4j.Logger;
42          /**  
43           * Set up the {@link Translation}-system to use language.  /**
44           * @param activeLang   * Represents a {@link HashMap} of translations. toString() returns the
45           */   * appropriate translation
46          public static void setActiveLang(String activeLang) {   *
47                  if (!I8NUtil.isValidISOLangCode(activeLang)) {   * @author @author <a href="mailto:[email protected]">Stefan Alfons
48                          throw new IllegalArgumentException("'"+activeLang+"' is not a valid ISO language code.");   *         Kr&uuml;ger</a>
49                  }   */
50    
51                  Locale.setDefault(new Locale(activeLang));  public class Translation extends HashMap<String, String> {
52                  Translation.activeLang = activeLang;          public static final String LOCALECHANGE_PROPERTY = "localechange";
53                  log.info("Translation-system switched to "+activeLang);          public static final String NO_TRANSLATION = "NO TRANSLATION";
54          }          public static final String DEFAULT_KEY = "default";
55            static final Logger log = Logger.getLogger(Translation.class);
56          /**          static String activeLang = Locale.getDefault().getLanguage();
57           * Initilises a new {@link Translation} with a default translation.  
58           * Other translations may be added later.          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();
59           *  
60           * @param defaultTranslation          static {
61           *  
62           * @deprecated SK: The concept of the default translation doesn't seem so nice to me anymore..                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
63           * I would prefer the default translation to be set for all valid languages.                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
64           *  
65           * @see public Translation(List<String> languages, String defaultTranslation) {                  // Get default locale
66           *                  Locale locale = Locale.getDefault();
67           */                  setActiveLang(locale.getLanguage());
68          public Translation(String defaultTranslation) {          }
69                  put(DEFAULT_KEY, defaultTranslation);  
70          }          @Override
71            /*
72          /**           * @comment To make a copy of a translation see methods toOneLine() and
73           * Initilises a new {@link Translation}, an uses the given String to           * fromOneLine()
74           * initialise the {@link Translation} for all languages codes passed.           */
75           *          public Translation clone() {
76           * The translations can be cahnged later                  return (Translation) super.clone();
77           */          }
78          public Translation(List<String> languages, String defaultTranslation) {  
79                  // put(DEFAULT_KEY, defaultTranslation);          /**
80                  if (languages == null) {           * Get the two-letter language sting that is active
81                          put(DEFAULT_KEY, defaultTranslation);           */
82                  }          public static String getActiveLang() {
83                  else for (String code : languages){                  return activeLang;
84                          put(code, defaultTranslation);          }
85                  }  
86          }          /**
87             * 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           * Sometimes Translations are optional, like for keywords.           * language equals the old language. The system's default locale is changed.
90           */           *
91          public Translation() {           * @param newLang
92                  super();           *            The ISO Code of the new active language
93          }           */
94            public static void setActiveLang(String newLang) {
95          /**                  setActiveLang(newLang, true);
96           * Fills the {@link Translation} with the values coded into the String          }
97           * Format of {@link String} is: "de{Baum}en{tree}"  
98           * <p>          /**
99           * <ul>           * Set up the {@link Translation}-system to use language. If a change is
100           * <li> If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.           * performed, events are fired to listeners. Nothing is done if the new
101           * <li> If format can't be recognized, the {@link String} is interpreted as the translation in the <code>{@value #DEFAULT_KEY}</code> language           * language equals the old language.
102           *           *
103           * @author Stefan Alfons Krüger           * @param newLang
104           */           *            The ISO Code of the new active language
105          public void fromOneLine( final String oneLineCoded) {           *
106                  clear();           * @param setDefaultLocale
107                  if ( (oneLineCoded == null) || (oneLineCoded.equals("")) ) {           *            Shall the system's default locale be changed?
108                          put(DEFAULT_KEY,NO_TRANSLATION);           */
109                          return;          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
110                  }                  if (getActiveLang().equals(newLang)) {
111                            return;
112                  if (oneLineCoded.indexOf("}") == -1) {                  }
113                  //      log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");  
114                          put(DEFAULT_KEY,oneLineCoded);                  if (!I8NUtil.isValidISOLangCode(newLang)) {
115                  }                          throw new IllegalArgumentException("'" + newLang
116                                            + "' is not a valid ISO language code.");
117                  String eatUp = oneLineCoded;                  }
118                  while ( eatUp.indexOf("}") != -1) {  
119                          String substring = eatUp.substring(0, eatUp.indexOf("}"));                  Locale newLocale = new Locale(newLang);
120                    if (setDefaultLocale)
121  //                      log.debug("substring = "+substring);                          Locale.setDefault(newLocale);
122                          String key   = substring.substring(0, substring.indexOf("{") );  
123                          String value = substring.substring(substring.indexOf("{")+1, substring.length() );                  /**
124  //                      log.debug("key="+key);                   * Setting default locale for Swing JComponents to work around bug
125  //                      log.debug("value="+value);                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
126                          put(key,value);                   */
127                          eatUp = eatUp.substring(eatUp.indexOf("}")+1);                  JComponent.setDefaultLocale(newLocale);
128                  }  
129          }                  Translation.activeLang = newLang;
130    
131          /**                  fireLocaleChangeEvents();
132           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"  
133           * @author Stefan Alfons Krüger                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
134           */          }
135          public String toOneLine(){  
136                  StringBuffer oneLine = new StringBuffer();          /**
137                  for (String key: keySet()) {           * Initializes a new {@link Translation} with a default translation if a
138                          oneLine.append(key+"{"+ get(key) + "}");           * 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                  return oneLine.toString();           *
141          }           * @param defaultTranslation
142             *
143          /**           * @see public Translation(List<String> languages, String
144           * Returns the right translation by using the {@link #activeLang} field.           *      defaultTranslation) {
145           * If no translation is set, an ugly String {@link #NO_TRANSLATION} will re returned. This might be changed for the final release.           *
146           * If the correct language was not found, any entry in the {@link Translation} {@link HashMap} will be returned, that contains           */
147           *  more than an empty string.          public Translation(String defaultTranslation) {
148           */  
149          @Override                  fromOneLine(defaultTranslation);
150          public String toString(){  
151                  if ( get(activeLang) != null ) {          }
152                          return get(activeLang);  
153                  }          /**
154                  //****************************************************************************           * Initializes a new {@link Translation}, an uses the given String to
155                  // MS: The ISDSS needs the concept of the default lang!! So I took the           * initialize the {@link Translation} for all languages codes passed.
156                  //     following in again!!           *
157                  //****************************************************************************           * The translations can be changed later
158  //              else return "";           */
159  //              //****************************************************************************          public Translation(List<String> languages, String defaultTranslation) {
160  //              // The following is commented out.. the concept of the default lang seems to be bad....                  // put(DEFAULT_KEY, defaultTranslation);
161  //              //****************************************************************************                  if (languages == null) {
162                  // MS:                          put(DEFAULT_KEY, defaultTranslation);
163                  else {                  } else
164                          if ( get(DEFAULT_KEY) != null ) {                          for (String code : languages) {
165  //                              log.debug("default lng returned, cuz the translation to "+activeLang+" was not found. Schmeiss raus martin, wenn du das mit der default trans geklärt hast.");                                  if (code.equals(getActiveLang())) {
166                                  return get(DEFAULT_KEY);                                          put(code, defaultTranslation);
167                          }                                  }
168                            }
169                          // log.debug("return first best <> '' ");          }
170                          if (size() > 0)  
171                                  for ( String s : values() ) {          /**
172                                          if ( (s != null) && (s.trim().length()>0) )           * Sometimes Translations are optional, like for keywords.
173                                                  return s;           */
174                                  }          public Translation() {
175                  }          }
176                  log.warn("No translation found!");  
177                  return NO_TRANSLATION;          /**
178          }           * Fills the {@link Translation} with the values coded into the String
179             * Format of {@link String} is: "de{Baum}en{tree}"
180          /**           * <p>
181           * Copy this {@link Translation} to another {@link Translation}           * <ul>
182           * e.g. for editing           * <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           * @return the destination {@link Translation}           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
185           */           *
186          public Translation copy(Translation backup) {           * @author Stefan Alfons Krüger
187                  if (backup == null) throw new IllegalArgumentException("Target translation may not be null.");           */
188                  for (String s : keySet() ) {          public void fromOneLine(final String oneLineCoded) {
189                          backup.put(s, get(s) );                  clear();
190                  }                  if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
191                  return backup;                          put(DEFAULT_KEY, "");
192          }                          return;
193                    }
194  }  
195                    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                    }
199    
200                    String eatUp = oneLineCoded;
201                    while (eatUp.indexOf("}") != -1) {
202                            String substring = eatUp.substring(0, eatUp.indexOf("}"));
203    
204                            // log.debug("substring = "+substring);
205                            String key = substring.substring(0, substring.indexOf("{"));
206                            String value = substring.substring(substring.indexOf("{") + 1,
207                                            substring.length());
208                            // log.debug("key="+key);
209                            // log.debug("value="+value);
210                            put(key, value);
211                            eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
212                    }
213            }
214    
215            /**
216             * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
217             *
218             * @author Stefan Alfons Krüger
219             */
220            public String toOneLine() {
221                    return I8NUtil.toOneLine(this);
222            }
223    
224            /**
225             * Returns the right translation by using the {@link #activeLang} field. If
226             * 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             * language was not found, any entry in the {@link Translation}
229             * {@link HashMap} will be returned, that contains more than an empty
230             * string.
231             */
232            @Override
233            public String toString() {
234                    if (get(activeLang) != null) {
235                            return get(activeLang);
236                    }
237                    // ****************************************************************************
238                    // MS: The ISDSS needs the concept of the default lang!! So I took the
239                    // following in again!!
240                    // ****************************************************************************
241                    // else return "";
242                    // //****************************************************************************
243                    // // 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.2  
changed lines
  Added in v.268
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26