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