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