/[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 186 by alfonx, Fri Jul 3 14:40:10 2009 UTC revision 292 by alfonx, Wed Aug 5 12:34:15 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.awt.event.ActionEvent;
33    import java.awt.event.ActionListener;
34                  // TODO default aus Locale auslesen und mit möglichen vergleichen...  import java.beans.PropertyChangeEvent;
35                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht  import java.beans.PropertyChangeListener;
36    import java.util.ArrayList;
37                  // Get default locale  import java.util.HashMap;
38                  Locale locale = Locale.getDefault();  import java.util.List;
39                  setActiveLang(locale.getLanguage());  import java.util.Locale;
40          }  import java.util.Random;
41    
42          @Override  import javax.swing.JComponent;
43          /*  
44           * @comment To make a copy of a translation see methods toOneLine() and  import org.apache.log4j.Logger;
45           * fromOneLine()  
46           */  /**
47          public Translation clone() {   * Represents a {@link HashMap} of translations. toString() returns the
48                  return (Translation) super.clone();   * appropriate translation
49          }   *
50     * @author @author <a href="mailto:[email protected]">Stefan Alfons
51          /**   *         Kr&uuml;ger</a>
52           * Get the two-letter language sting that is active   */
53           */  
54          public static String getActiveLang() {  public class Translation extends HashMap<String, String> {
55                  return activeLang;          public static final String LOCALECHANGE_PROPERTY = "localechange";
56          }          public static final String NO_TRANSLATION = "NO TRANSLATION";
57            public static final String DEFAULT_KEY = "default";
58          /**          static final Logger log = Logger.getLogger(Translation.class);
59           * Set up the {@link Translation}-system to use language. If a change is          static String activeLang = Locale.getDefault().getLanguage();
60           * performed, events are fired to listeners. Nothing is done if the new  
61           * language equals the old language. The system's default locale is changed.          static protected List<PropertyChangeListener> listeners = new ArrayList<PropertyChangeListener>();
62           *  
63           * @param newLang          static {
64           *            The ISO Code of the new active language  
65           */                  // TODO default aus Locale auslesen und mit möglichen vergleichen...
66          public static void setActiveLang(String newLang) {                  // mmm.. vor laden von atlasml immer DEFAULT_KEY, also hier nicht
67                  setActiveLang(newLang, true);  
68          }                  // Get default locale
69                    Locale locale = Locale.getDefault();
70          /**                  setActiveLang(locale.getLanguage());
71           * Set up the {@link Translation}-system to use language. If a change is          }
72           * performed, events are fired to listeners. Nothing is done if the new  
73           * language equals the old language.          private List<ActionListener> actionListeners = new ArrayList<ActionListener>();
74           *  
75           * @param newLang          @Override
76           *            The ISO Code of the new active language          /*
77           *           * @comment To make a copy of a translation see methods toOneLine() and
78           * @param setDefaultLocale           * fromOneLine()
79           *            Shall the system's default locale be changed?           */
80           */          public Translation clone() {
81          public static void setActiveLang(String newLang, boolean setDefaultLocale) {                  return (Translation) super.clone();
82                  if (getActiveLang().equals(newLang)) {          }
83                          return;  
84                  }          /**
85             * Get the two-letter language sting that is active
86                  if (!I8NUtil.isValidISOLangCode(newLang)) {           */
87                          throw new IllegalArgumentException("'" + newLang          public static String getActiveLang() {
88                                          + "' is not a valid ISO language code.");                  return activeLang;
89                  }          }
90    
91                  Locale newLocale = new Locale(newLang);          /**
92                  if (setDefaultLocale)           * Set up the {@link Translation}-system to use language. If a change is
93                          Locale.setDefault(newLocale);           * performed, events are fired to listeners. Nothing is done if the new
94             * language equals the old language. The system's default locale is changed.
95                  /**           *
96                   * Setting default locale for Swing JComponents to work around bug           * @param newLang
97                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480           *            The ISO Code of the new active language
98                   */           */
99                  JComponent.setDefaultLocale(newLocale);          public static void setActiveLang(String newLang) {
100                    setActiveLang(newLang, true);
101                  Translation.activeLang = newLang;          }
102    
103                  fireChangeEvents();          /**
104             * Set up the {@link Translation}-system to use language. If a change is
105                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);           * performed, events are fired to listeners. Nothing is done if the new
106          }           * language equals the old language.
107             *
108          /**           * @param newLang
109           * Initializes a new {@link Translation} with a default translation if a           *            The ISO Code of the new active language
110           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.           *
111           * Other translations may be added later - this is a HashMap<br/>           * @param setDefaultLocale
112           *           *            Shall the system's default locale be changed?
113           * @param defaultTranslation           */
114           *          public static void setActiveLang(String newLang, boolean setDefaultLocale) {
115           * @see public Translation(List<String> languages, String                  if (getActiveLang().equals(newLang)) {
116           *      defaultTranslation) {                          return;
117           *                  }
118           */  
119          public Translation(String defaultTranslation) {                  if (!I8NUtil.isValidISOLangCode(newLang)) {
120                            throw new IllegalArgumentException("'" + newLang
121                  fromOneLine(defaultTranslation);                                          + "' is not a valid ISO language code.");
122                    }
123          }  
124                    Locale newLocale = new Locale(newLang);
125          /**                  if (setDefaultLocale)
126           * Initializes a new {@link Translation}, an uses the given String to                          Locale.setDefault(newLocale);
127           * initialize the {@link Translation} for all languages codes passed.  
128           *                  /**
129           * The translations can be changed later                   * Setting default locale for Swing JComponents to work around bug
130           */                   * http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4884480
131          public Translation(List<String> languages, String defaultTranslation) {                   */
132                  // put(DEFAULT_KEY, defaultTranslation);                  JComponent.setDefaultLocale(newLocale);
133                  if (languages == null) {  
134                          put(DEFAULT_KEY, defaultTranslation);                  Translation.activeLang = newLang;
135                  } else  
136                          for (String code : languages) {                  fireLocaleChangeEvents();
137                                  if (code.equals(getActiveLang())) {  
138                                          put(code, defaultTranslation);                  log.info("skrueger.i8n.Translation switched ActiveLang to " + newLang);
139                                  }          }
140                          }  
141          }          /**
142             * Initializes a new {@link Translation} with a default translation if a
143          /**           * simple text is passed. If a "oneLine" text is parsed, it is interpreted.
144           * Sometimes Translations are optional, like for keywords.           * Other translations may be added later - this is a HashMap<br/>
145           */           *
146          public Translation() {           * @param defaultTranslation
147          }           *
148             * @see public Translation(List<String> languages, String
149          /**           *      defaultTranslation) {
150           * Fills the {@link Translation} with the values coded into the String           *
151           * Format of {@link String} is: "de{Baum}en{tree}"           */
152           * <p>          public Translation(String defaultTranslation) {
153           * <ul>  
154           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.                  fromOneLine(defaultTranslation);
155           * <li>If format can't be recognized, the {@link String} is interpreted as  
156           * the translation in the <code>{@value #DEFAULT_KEY}</code> language          }
157           *  
158           * @author Stefan Alfons Krüger          /**
159           */           * Initializes a new {@link Translation}, an uses the given String to
160          public void fromOneLine(final String oneLineCoded) {           * initialize the {@link Translation} for all languages codes passed.
161                  clear();           *
162                  if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {           * The translations can be changed later
163                          put(DEFAULT_KEY, "");           */
164                          return;          public Translation(List<String> languages, String defaultTranslation) {
165                  }                  // put(DEFAULT_KEY, defaultTranslation);
166                    if (languages == null) {
167                  if (oneLineCoded.indexOf("}") == -1) {                          put(DEFAULT_KEY, defaultTranslation);
168                          // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");                  } else
169                          put(DEFAULT_KEY, oneLineCoded);                          for (String code : languages) {
170                  }                                  if (code.equals(getActiveLang())) {
171                                            put(code, defaultTranslation);
172                  String eatUp = oneLineCoded;                                  }
173                  while (eatUp.indexOf("}") != -1) {                          }
174                          String substring = eatUp.substring(0, eatUp.indexOf("}"));          }
175    
176                          // log.debug("substring = "+substring);          /**
177                          String key = substring.substring(0, substring.indexOf("{"));           * Sometimes Translations are optional, like for keywords.
178                          String value = substring.substring(substring.indexOf("{") + 1,           */
179                                          substring.length());          public Translation() {
180                          // log.debug("key="+key);          }
181                          // log.debug("value="+value);  
182                          put(key, value);          /**
183                          eatUp = eatUp.substring(eatUp.indexOf("}") + 1);           * Fills the {@link Translation} with the values coded into the String
184                  }           * Format of {@link String} is: "de{Baum}en{tree}"
185          }           * <p>
186             * <ul>
187          /**           * <li>If <code>oneLineCoded</code> is empty or null, NO TRANSLATION is set.
188           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"           * <li>If format can't be recognized, the {@link String} is interpreted as
189           *           * the translation in the <code>{@value #DEFAULT_KEY}</code> language
190           * @author Stefan Alfons Krüger           *
191           */           * @author Stefan Alfons Krüger
192          public String toOneLine() {           */
193                  return I8NUtil.toOneLine(this);          public void fromOneLine(final String oneLineCoded) {
194          }                  clear();
195                    if ((oneLineCoded == null) || (oneLineCoded.equals(""))) {
196          /**                          put(DEFAULT_KEY, "");
197           * Returns the right translation by using the {@link #activeLang} field. If                          return;
198           * no translation is set, an ugly String {@link #NO_TRANSLATION} will re                  }
199           * returned. This might be changed for the final release. If the correct  
200           * language was not found, any entry in the {@link Translation}                  if (oneLineCoded.indexOf("}") == -1) {
201           * {@link HashMap} will be returned, that contains more than an empty                          // log.warn("The String '"+oneLineCoded+"' is not in oneLine coded => put(DEFAULT_KEY,oneLineCoded);");
202           * string.                          put(DEFAULT_KEY, oneLineCoded);
203           */                  }
204          @Override  
205          public String toString() {                  String eatUp = oneLineCoded;
206                  if (get(activeLang) != null) {                  while (eatUp.indexOf("}") != -1) {
207                          return get(activeLang);                          String substring = eatUp.substring(0, eatUp.indexOf("}"));
208                  }  
209                  // ****************************************************************************                          // log.debug("substring = "+substring);
210                  // MS: The ISDSS needs the concept of the default lang!! So I took the                          String key = substring.substring(0, substring.indexOf("{"));
211                  // following in again!!                          String value = substring.substring(substring.indexOf("{") + 1,
212                  // ****************************************************************************                                          substring.length());
213                  // else return "";                          // log.debug("key="+key);
214                  // //****************************************************************************                          // log.debug("value="+value);
215                  // // The following is commented out.. the concept of the default lang                          put(key, value);
216                  // seems to be bad....                          eatUp = eatUp.substring(eatUp.indexOf("}") + 1);
217                  // //****************************************************************************                  }
218                  // MS:          }
219                  else {  
220                          if (get(DEFAULT_KEY) != null) {          /**
221                                  // 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.");           * Exports the Translations to a String of the Format: "de{Baum}en{tree}"
222                                  return get(DEFAULT_KEY);           *
223                          }           * @author Stefan Alfons Krüger
224             */
225                          // log.debug("return first best <> '' ");          public String toOneLine() {
226                          if (size() > 0)                  return I8NUtil.toOneLine(this);
227                                  for (String s : values()) {          }
228                                          if ((s != null) && (s.trim().length() > 0))  
229                                                  return s;          /**
230                                  }           * Returns the right translation by using the {@link #activeLang} field. If
231                  }           * no translation is set, an ugly String {@link #NO_TRANSLATION} will re
232                  log.warn("No translation found!");           * returned. This might be changed for the final release. If the correct
233                  return NO_TRANSLATION;           * language was not found, any entry in the {@link Translation}
234          }           * {@link HashMap} will be returned, that contains more than an empty
235             * string.
236          /**           */
237           * Copy this {@link Translation} to another {@link Translation} e.g. for          @Override
238           * editing          public String toString() {
239           *                  if (get(activeLang) != null) {
240           * @return the destination {@link Translation}                          return get(activeLang);
241           */                  }
242          public Translation copy(Translation backup) {                  // ****************************************************************************
243                  if (backup == null)                  // MS: The ISDSS needs the concept of the default lang!! So I took the
244                          throw new IllegalArgumentException(                  // following in again!!
245                                          "Target translation may not be null.");                  // ****************************************************************************
246                  for (String s : keySet()) {                  // else return "";
247                          backup.put(s, get(s));                  // //****************************************************************************
248                  }                  // // The following is commented out.. the concept of the default lang
249                  return backup;                  // seems to be bad....
250          }                  // //****************************************************************************
251                    // MS:
252          /**                  else {
253           * {@link PropertyChangeListener} can be registered to be informed when the                          if (get(DEFAULT_KEY) != null) {
254           * {@link Locale} changed.                                  // 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.");
255           *                                  return get(DEFAULT_KEY);
256           * @param propertyChangeListener                          }
257           */  
258          public static void addLocaleChangeListener(                          // log.debug("return first best <> '' ");
259                          PropertyChangeListener propertyChangeListener) {                          if (size() > 0)
260                  listeners.add(propertyChangeListener);                                  for (String s : values()) {
261          }                                          if ((s != null) && (s.trim().length() > 0))
262                                                    return s;
263          /**                                  }
264           * Informs all registered {@link PropertyChangeListener}s about a change of                  }
265           * the the {@link Locale}.  //              log.warn("No translation found!");
266           */                  return NO_TRANSLATION;
267          public static void fireChangeEvents() {          }
268                  PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(  
269                                  new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,          /**
270                                  null, getActiveLang());           * Copy this {@link Translation} to another {@link Translation} e.g. for
271                  for (PropertyChangeListener pcl : listeners) {           * editing
272                          if (pcl != null)           *
273                                  pcl.propertyChange(pce);           * @return the destination {@link Translation}
274                  }           */
275          }          public Translation copy(Translation backup) {
276                    if (backup == null)
277  }                          throw new IllegalArgumentException(
278                                            "Target translation may not be null.");
279                    for (String s : keySet()) {
280                            backup.put(s, get(s));
281                    }
282                    return backup;
283            }
284    
285            /**
286             * {@link PropertyChangeListener} can be registered to be informed when the
287             * {@link Locale} changed.
288             *
289             * @param propertyChangeListener
290             */
291            public static void addLocaleChangeListener(
292                            PropertyChangeListener propertyChangeListener) {
293                    listeners.add(propertyChangeListener);
294            }
295    
296            /**
297             * Informs all registered {@link PropertyChangeListener}s about a change of
298             * the the {@link Locale}.
299             */
300            public static void fireLocaleChangeEvents() {
301                    PropertyChangeEvent pce = new PropertyChangeEvent(new Translation(
302                                    new ArrayList<String>(), "fakeSource"), LOCALECHANGE_PROPERTY,
303                                    null, getActiveLang());
304                    for (PropertyChangeListener pcl : listeners) {
305                            if (pcl != null)
306                                    pcl.propertyChange(pce);
307                    }
308            }
309    
310            public void addTranslationChangeListener(ActionListener actionListener) {
311                    actionListeners.add(actionListener);
312            }
313            
314            public boolean removeTranslationChangeListener(ActionListener actionListener) {
315                    return actionListeners.remove(actionListener);
316            }
317    
318            public void fireTranslationChangedEvents() {
319                    ActionEvent ae = new ActionEvent(this, new Random().nextInt(),  "");
320                    
321                    for (ActionListener al : actionListeners) {
322                            al.actionPerformed( ae);
323                    }
324            }
325            
326            @Override
327            public String put(String key, String value) {
328                    String result = super.put(key, value);
329                    fireTranslationChangedEvents();
330                    return result;
331            }
332            
333            
334    }
Legend:
Removed from v.186  
changed lines
  Added in v.292
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26