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