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