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