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