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