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