/[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

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