svn-gvsig-desktop / tags / v1_0_2_Build_911 / libraries / libInternationalization / src / org / gvsig / i18n / Messages.java @ 11388
History | View | Annotate | Download (22.9 KB)
1 | 4780 | cesar | /* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
|
---|---|---|---|
2 | *
|
||
3 | * Copyright (C) 2006 IVER T.I. and Generalitat Valenciana.
|
||
4 | *
|
||
5 | * This program is free software; you can redistribute it and/or
|
||
6 | * modify it under the terms of the GNU General Public License
|
||
7 | * as published by the Free Software Foundation; either version 2
|
||
8 | * of the License, or (at your option) any later version.
|
||
9 | *
|
||
10 | * This program is distributed in the hope that it will be useful,
|
||
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
13 | * GNU General Public License for more details.
|
||
14 | *
|
||
15 | * You should have received a copy of the GNU General Public License
|
||
16 | * along with this program; if not, write to the Free Software
|
||
17 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,USA.
|
||
18 | *
|
||
19 | * For more information, contact:
|
||
20 | *
|
||
21 | * Generalitat Valenciana
|
||
22 | * Conselleria d'Infraestructures i Transport
|
||
23 | * Av. Blasco Ib??ez, 50
|
||
24 | * 46010 VALENCIA
|
||
25 | * SPAIN
|
||
26 | *
|
||
27 | * +34 963862235
|
||
28 | * gvsig@gva.es
|
||
29 | * www.gvsig.gva.es
|
||
30 | *
|
||
31 | * or
|
||
32 | *
|
||
33 | * IVER T.I. S.A
|
||
34 | * Salamanca 50
|
||
35 | * 46005 Valencia
|
||
36 | * Spain
|
||
37 | *
|
||
38 | * +34 963163400
|
||
39 | * dac@iver.es
|
||
40 | */
|
||
41 | |||
42 | 4460 | cesar | package org.gvsig.i18n; |
43 | |||
44 | 5767 | cesar | import java.io.File; |
45 | 4587 | cesar | import java.net.MalformedURLException; |
46 | import java.net.URL; |
||
47 | import java.net.URLClassLoader; |
||
48 | 5767 | cesar | import java.util.ArrayList; |
49 | import java.util.Enumeration; |
||
50 | import java.util.HashMap; |
||
51 | 8765 | jjdelcerro | import java.util.Iterator; |
52 | 5767 | cesar | import java.util.List; |
53 | import java.util.Locale; |
||
54 | import java.util.MissingResourceException; |
||
55 | import java.util.ResourceBundle; |
||
56 | import java.util.StringTokenizer; |
||
57 | 4587 | cesar | |
58 | 4460 | cesar | import org.apache.log4j.Logger; |
59 | |||
60 | /**
|
||
61 | 4728 | cesar | * <p>This class offers some methods to provide internationalization services
|
62 | * to other projects. All the methods are static.</p>
|
||
63 | *
|
||
64 | * <p>The most useful method is {@link #getText(String) getText(key)} (and family),
|
||
65 | * which returns the translation associated
|
||
66 | * with the provided key. The class must be initialized before getText can be
|
||
67 | * used.</p>
|
||
68 | *
|
||
69 | * <p>The typical usage sequence would be:</p>
|
||
70 | * <ul>
|
||
71 | * <li>Add some locale to the prefered locales list: <code>Messages.addLocale(new Locale("es"))</code></li>
|
||
72 | * <li>Add some resource file containing translations: <code>Messages.addResourceFamily("text", new File("."))</code></li>
|
||
73 | * <li>And finaly getText can be used: <code>Messages.getText("aceptar")</code></li>
|
||
74 | * </ul>
|
||
75 | *
|
||
76 | * <p>The resource files are Java properties files, which contain <code>key=translation</code>
|
||
77 | * pairs, one
|
||
78 | * pair per line. These files must be encoded using iso-8859-1 encoding, and unicode escaped
|
||
79 | * sequences must be used to include characters outside the former encoding.
|
||
80 | * There are several ways to specify the property file to load, see the different
|
||
81 | * addResourceFamily methods for details.</p>
|
||
82 | *
|
||
83 | 6294 | cesar | * @author Cesar Martinez Izquierdo (cesar.martinez@iver.es)
|
84 | 4460 | cesar | *
|
85 | */
|
||
86 | public class Messages { |
||
87 | private static Logger logger = Logger.getLogger("Messages"); |
||
88 | 4516 | cesar | private static String _CLASSNAME = "org.gvsig.i18n.Messages"; |
89 | 5599 | cesar | private static int _INITIALSIZE = 3700; // I try to set an initial capacity similar to the amount of strings in gvSIG |
90 | 4460 | cesar | |
91 | 5767 | cesar | /* Each entry will contain a hashmap with translations. Each hasmap
|
92 | * contains the translations for one language, indexed by the
|
||
93 | * translation key. The translations for language (i) in the preferred locales
|
||
94 | * list are contained in the position (i) of the localeResources list */
|
||
95 | private static ArrayList localeResources = new ArrayList(); |
||
96 | private static ArrayList preferredLocales = new ArrayList(); // contains the ordered list of prefered languages/locales (class Locale) |
||
97 | 4460 | cesar | |
98 | /**
|
||
99 | 4728 | cesar | * <p>Gets the localized message associated with the provided key.
|
100 | * If the key is not in the dictionary, return the key and register
|
||
101 | * the failure in the log.</p>
|
||
102 | *
|
||
103 | * <p>The <code>callerName</code> parameter is only
|
||
104 | * used as a label when logging, so any String can be used. However, a
|
||
105 | * meaningful String should be used, such as the name of the class requiring
|
||
106 | * the translation services, in order to identify the source of the failure
|
||
107 | * in the log.</p>
|
||
108 | *
|
||
109 | * @param key An String which identifies the translation that we want to get.
|
||
110 | 4516 | cesar | * @param callerName A symbolic name given to the caller of this method, to
|
111 | 4728 | cesar | * show it in the log if the key was not found
|
112 | * @return an String with the message associated with the provided key.
|
||
113 | * If the key is not in the dictionary, return the key. If the key
|
||
114 | * is null, return null.
|
||
115 | 4460 | cesar | */
|
116 | 4516 | cesar | public static String getText(String key, String callerName) { |
117 | if (key==null) return null; |
||
118 | 5767 | cesar | for (int numLocale=0; numLocale<localeResources.size(); numLocale++) { |
119 | // try to get the translation for any of the languagues in the preferred languages list
|
||
120 | String translation = (String) ((HashMap)localeResources.get(numLocale)).get(key); |
||
121 | 6343 | cesar | if (translation!=null && !translation.equals("")) |
122 | 5767 | cesar | return translation;
|
123 | } |
||
124 | 8765 | jjdelcerro | logger.warn(callerName+ " -- " +Messages.getText("No_se_encontro_la_traduccion_para", _CLASSNAME ,false)+" "+key); |
125 | 4460 | cesar | return key;
|
126 | } |
||
127 | |||
128 | /**
|
||
129 | 4728 | cesar | * <p>Gets the localized message associated with the provided key.
|
130 | 6664 | cesar | * If the key is not in the dictionary or the translation is empty,
|
131 | * return the key and register the failure in the log.</p>
|
||
132 | 4518 | cesar | *
|
133 | 4728 | cesar | * @param key An String which identifies the translation that we want to get.
|
134 | * @return an String with the message associated with the provided key.
|
||
135 | 6664 | cesar | * If the key is not in the dictionary or the translation is empty,
|
136 | * return the key. If the key is null, return null.
|
||
137 | 4518 | cesar | */
|
138 | public static String getText(String key) { |
||
139 | 5767 | cesar | return getText(key, _CLASSNAME);
|
140 | 4518 | cesar | } |
141 | |||
142 | /**
|
||
143 | 4728 | cesar | * <p>Gets the localized message associated with the provided key.
|
144 | 6664 | cesar | * If the key is not in the dictionary or the translation is empty,
|
145 | * it returns null and the failure is only registered in the log if
|
||
146 | * the param log is true.</p>
|
||
147 | 4460 | cesar | *
|
148 | 6664 | cesar | * @param key An String which identifies the translation that we want
|
149 | * to get.
|
||
150 | * @param log Determines whether log a key failure or not
|
||
151 | * @return an String with the message associated with the provided key,
|
||
152 | * or null if the key is not in the dictionary or the
|
||
153 | * translation is empty.
|
||
154 | 4460 | cesar | */
|
155 | 4728 | cesar | public static String getText(String key, boolean log) { |
156 | 5767 | cesar | return getText(key, _CLASSNAME, log);
|
157 | 4736 | cesar | } |
158 | |||
159 | /**
|
||
160 | * <p>Gets the localized message associated with the provided key.
|
||
161 | * If the key is not in the dictionary, it returns null and the failure
|
||
162 | * is only registered in the log if the param log is true.</p>
|
||
163 | *
|
||
164 | * @param key An String which identifies the translation that we want to get.
|
||
165 | * @param callerName A symbolic name given to the caller of this method, to
|
||
166 | * show it in the log if the key was not found
|
||
167 | * @param log Determines whether log a key failure or not
|
||
168 | * @return an String with the message associated with the provided key,
|
||
169 | * or null if the key is not in the dictionary.
|
||
170 | */
|
||
171 | public static String getText(String key, String callerName, boolean log) { |
||
172 | if (key==null) return null; |
||
173 | 5767 | cesar | for (int numLocale=0; numLocale<localeResources.size(); numLocale++) { |
174 | // try to get the translation for any of the languagues in the preferred languages list
|
||
175 | String translation = (String) ((HashMap)localeResources.get(numLocale)).get(key); |
||
176 | 6343 | cesar | if (translation!=null && !translation.equals("")) |
177 | 5767 | cesar | return translation;
|
178 | } |
||
179 | 5599 | cesar | if (log) {
|
180 | 8765 | jjdelcerro | logger.warn(callerName+" -- "+Messages.getText("No_se_encontro_la_traduccion_para", _CLASSNAME ,false)+" "+key); |
181 | 5599 | cesar | } |
182 | 5767 | cesar | return null; |
183 | 4736 | cesar | } |
184 | 4516 | cesar | |
185 | 4460 | cesar | /**
|
186 | 4728 | cesar | * <p>Adds an additional family of resource files containing some translations.
|
187 | 4460 | cesar | * A family is a group of files with a common baseName.
|
188 | 4728 | cesar | * The file must be an iso-8859-1 encoded file, which can contain any unicode
|
189 | * character using unicode escaped sequences, and following the syntax:
|
||
190 | * <code>key1=value1
|
||
191 | * key2=value2</code>
|
||
192 | 4460 | cesar | * where 'key1' is the key used to identify the string and must not
|
193 | 4728 | cesar | * contain the '=' symbol, and 'value1' is the associated translation.</p>
|
194 | * <p<For example:</p>
|
||
195 | * <code>cancel=Cancelar
|
||
196 | * accept=Aceptar</code>
|
||
197 | * <p>Only one pair key-value is allowed per line.</p>
|
||
198 | 4460 | cesar | *
|
199 | 4728 | cesar | * <p>The actual name of the resource file to load is determined using the rules
|
200 | * explained in the class java.util.ResourceBundle. Summarizing, for each language
|
||
201 | * in the specified preferred locales list it will try to load a file with
|
||
202 | * the following structure: <code>family_locale.properties</code></p>
|
||
203 | *
|
||
204 | * <p>For example, if the preferred locales list contains {"fr", "es", "en"}, and
|
||
205 | * the family name is "text", it will try to load the files "text_fr.properties",
|
||
206 | * "text_es.properties" and finally "text_en.properties".</p>
|
||
207 | *
|
||
208 | * <p>Locales might be more specific, such us "es_AR" (meaning Spanish from Argentina)
|
||
209 | * or "es_AR_linux" (meaning Linux system preferring Spanish from Argentina). In the
|
||
210 | * later case, it will try to load "text_es_AR_linux.properties", then
|
||
211 | * "text_es_AR.properties" if the former fails, and finally "text_es.properties".</p>
|
||
212 | *
|
||
213 | * <p>The directory used to locate the resource file is determining by using the
|
||
214 | * getResource method from the provided ClassLoader.</p>
|
||
215 | *
|
||
216 | * @param family The family name (or base name) which is used to search
|
||
217 | * actual properties files.
|
||
218 | * @param loader A ClassLoader which is able to find a property file matching
|
||
219 | * the specified family name and the preferred locales
|
||
220 | * @see <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html">ResourceBundle</a>
|
||
221 | 4460 | cesar | */
|
222 | 4516 | cesar | public static void addResourceFamily(String family, ClassLoader loader) { |
223 | 5767 | cesar | addResourceFamily(family, loader, "");
|
224 | 4516 | cesar | } |
225 | 4587 | cesar | |
226 | 4728 | cesar | /**
|
227 | * <p>Adds an additional family of resource files containing some translations.
|
||
228 | * The search path to locate the files is provided by the dirList parameter.</p>
|
||
229 | *
|
||
230 | * <p>See {@link addResourceFamily(String, ClassLoader)} for a discussion about the
|
||
231 | * format of the property files and the way to determine the candidat files
|
||
232 | * to load. Note that those methods are different in the way to locate the
|
||
233 | * candidat files. This method searches in the provided paths (<code>dirList</code>
|
||
234 | * parameter), while the referred method searches using the getResource method
|
||
235 | * of the provided ClassLoader.</p>
|
||
236 | *
|
||
237 | * @param family The family name (or base name) which is used to search
|
||
238 | * actual properties files.
|
||
239 | * @param dirList A list of search paths to locate the property files
|
||
240 | * @throws MalformedURLException
|
||
241 | * @see <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html">ResourceBundle</a>
|
||
242 | */
|
||
243 | 4587 | cesar | public static void addResourceFamily(String family, File[] dirList) throws MalformedURLException{ |
244 | 4597 | cesar | // use our own classloader
|
245 | 4587 | cesar | URL[] urls = new URL[dirList.length]; |
246 | |||
247 | int i;
|
||
248 | for (i=0; i<urls.length; i++) { |
||
249 | urls[i] = dirList[i].toURL(); |
||
250 | } |
||
251 | |||
252 | 5868 | cesar | ClassLoader loader = new MessagesClassLoader(urls); |
253 | 5767 | cesar | addResourceFamily(family, loader, "");
|
254 | 4587 | cesar | } |
255 | 4516 | cesar | |
256 | 4728 | cesar | /**
|
257 | * <p>Adds an additional family of resource files containing some translations.
|
||
258 | * The search path to locate the files is provided by the dir parameter.</p>
|
||
259 | *
|
||
260 | * <p>See {@link addResourceFamily(String, ClassLoader)} for a discussion about the
|
||
261 | * format of the property files and the way to determine the candidat files
|
||
262 | * to load. Note that those methods are different in the way to locate the
|
||
263 | * candidat files. This method searches in the provided path (<code>dir</code>
|
||
264 | * parameter), while the referred method searches using the getResource method
|
||
265 | * of the provided ClassLoader.</p>
|
||
266 | *
|
||
267 | * @param family The family name (or base name) which is used to search
|
||
268 | * actual properties files.
|
||
269 | * @param dir The search path to locate the property files
|
||
270 | * @throws MalformedURLException
|
||
271 | * @see <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html">ResourceBundle</a>
|
||
272 | */
|
||
273 | 4587 | cesar | public static void addResourceFamily(String family, File dir) throws MalformedURLException{ |
274 | 4597 | cesar | // use our own classloader
|
275 | 4587 | cesar | URL[] urls = new URL[1]; |
276 | urls[0] = dir.toURL();
|
||
277 | 5868 | cesar | ClassLoader loader = new MessagesClassLoader(urls); |
278 | 5767 | cesar | addResourceFamily(family, loader, "");
|
279 | 4587 | cesar | } |
280 | |||
281 | |||
282 | 4516 | cesar | /**
|
283 | 4728 | cesar | * <p>Adds an additional family of resource files containing some translations.
|
284 | * The search path is determined by the getResource method from the
|
||
285 | * provided ClassLoader.</p>
|
||
286 | 4516 | cesar | *
|
287 | 4728 | cesar | * <p>This method is identical to {@link addResourceFamily(String, ClassLoader)},
|
288 | * except that it adds a <pode>callerName</code> parameter to show in the log.</p>
|
||
289 | *
|
||
290 | * <p>See {@link addResourceFamily(String, ClassLoader)} for a discussion about the
|
||
291 | * format of the property files andthe way to determine the candidat files
|
||
292 | * to load.</p>
|
||
293 | *
|
||
294 | * @param family The family name (or base name) which is used to search
|
||
295 | * actual properties files.
|
||
296 | * @param loader A ClassLoader which is able to find a property file matching
|
||
297 | * the specified family name and the preferred locales
|
||
298 | * @param callerName A symbolic name given to the caller of this method, to
|
||
299 | * show it in the log if there is an error
|
||
300 | * @see <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html">ResourceBundle</a>
|
||
301 | 4516 | cesar | */
|
302 | public static void addResourceFamily(String family, ClassLoader loader, String callerName) { |
||
303 | String currentKey;
|
||
304 | 5767 | cesar | Enumeration properties;
|
305 | int totalLocales = preferredLocales.size();
|
||
306 | |||
307 | if (totalLocales == 0) { |
||
308 | 4728 | cesar | // if it's empty, warn about that
|
309 | 8765 | jjdelcerro | logger.warn(Messages.getText("No_hay_lista_de_idiomas_preferidos_quiza_olvido_inicializar_clase", _CLASSNAME, false)); |
310 | 4780 | cesar | } |
311 | 4516 | cesar | Locale lang;
|
312 | ResourceBundle bundle = null; |
||
313 | |||
314 | 5767 | cesar | for (int numLocale=0; numLocale<totalLocales; numLocale++) { // for each language |
315 | lang = (Locale) preferredLocales.get(numLocale);
|
||
316 | 4597 | cesar | try {
|
317 | 5767 | cesar | /**
|
318 | * Here we are doing a pervert use of getBundle method. Normally, it is call it in in this way:
|
||
319 | * getBundle("text", "en", loader), in order to get the file 'text_en.properties'. However, in
|
||
320 | * this way the default file ('text.properties') is also loaded, and we want to avoid this
|
||
321 | * (because 'text.properties contains the Spanish translation).
|
||
322 | * So we use the method in this non-standard way:
|
||
323 | * getBundle("text_en", "en", loader), ensuring that we are just loading the file 'text_en.properties'
|
||
324 | **/
|
||
325 | if (!lang.getLanguage().equals("es")) |
||
326 | bundle = ResourceBundle.getBundle(family+"_"+lang.getLanguage(), lang, loader); |
||
327 | else // we allow 'text.properties' to be loaded for Spanish |
||
328 | bundle = ResourceBundle.getBundle(family, lang, loader);
|
||
329 | 4597 | cesar | |
330 | 5767 | cesar | properties = bundle.getKeys(); |
331 | while (properties.hasMoreElements()) {
|
||
332 | currentKey = (String) properties.nextElement();
|
||
333 | if (! ((HashMap)localeResources.get(numLocale)).containsKey(currentKey)) { |
||
334 | ((HashMap)localeResources.get(numLocale)).put(currentKey, bundle.getString(currentKey));
|
||
335 | 4460 | cesar | } |
336 | } |
||
337 | } |
||
338 | 4597 | cesar | catch (MissingResourceException ex) { |
339 | 8765 | jjdelcerro | logger.warn(Messages.getText("Las_traducciones_no_pudieron_ser_cargadas", false)+" -- "+callerName+" -- "+lang.getLanguage()); |
340 | 4597 | cesar | } |
341 | 4460 | cesar | } |
342 | } |
||
343 | |||
344 | 4728 | cesar | /**
|
345 | * <p>Adds an additional family of resource files containing some translations.</p>
|
||
346 | *
|
||
347 | * <p>This method is identical to {@link addResourceFamily(String, ClassLoader, String)},
|
||
348 | * except that it uses the caller's class loader.</p>
|
||
349 | *
|
||
350 | * <p>See {@link addResourceFamily(String, ClassLoader)} for a discussion about the
|
||
351 | * format of the property files and the way to determine the candidat files
|
||
352 | * to load.</p>
|
||
353 | *
|
||
354 | * @param family The family name (or base name) which is used to search
|
||
355 | * actual properties files.
|
||
356 | * @param callerName A symbolic name given to the caller of this method, to
|
||
357 | * show it in the log if there is an error. This is only used
|
||
358 | * to show
|
||
359 | * something meaningful in the log, so you can use any string
|
||
360 | * @see <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html">ResourceBundle</a>
|
||
361 | */
|
||
362 | public static void addResourceFamily(String family, String callerName) { |
||
363 | String currentKey;
|
||
364 | 5767 | cesar | Enumeration properties;
|
365 | int totalLocales = preferredLocales.size();
|
||
366 | |||
367 | if (totalLocales == 0) { |
||
368 | 4728 | cesar | // if it's empty, warn about that
|
369 | 8765 | jjdelcerro | logger.warn(Messages.getText("No_hay_lista_de_idiomas_preferidos_quiza_olvido_inicializar_clase", _CLASSNAME, false)); |
370 | 5767 | cesar | } |
371 | 4728 | cesar | Locale lang;
|
372 | ResourceBundle bundle = null; |
||
373 | |||
374 | 5767 | cesar | for (int numLocale=0; numLocale<totalLocales; numLocale++) { // for each language |
375 | 4728 | cesar | try {
|
376 | 5767 | cesar | lang = (Locale) preferredLocales.get(numLocale);
|
377 | 8765 | jjdelcerro | if (!lang.getLanguage().equals("es")) // ensure we don't get a fallback |
378 | 6294 | cesar | bundle = ResourceBundle.getBundle(family+"_"+lang.getLanguage(), lang); |
379 | else // we allow 'text.properties' to be loaded for Spanish |
||
380 | bundle = ResourceBundle.getBundle(family, lang);
|
||
381 | 5767 | cesar | |
382 | 8765 | jjdelcerro | properties = bundle.getKeys(); |
383 | while (properties.hasMoreElements()) {
|
||
384 | currentKey = (String) properties.nextElement();
|
||
385 | if (! ((HashMap)localeResources.get(numLocale)).containsKey(currentKey)) { |
||
386 | ((HashMap)localeResources.get(numLocale)).put(currentKey, bundle.getString(currentKey));
|
||
387 | 4728 | cesar | } |
388 | 8765 | jjdelcerro | } |
389 | 4728 | cesar | } |
390 | catch (MissingResourceException ex) { |
||
391 | 6294 | cesar | logger.warn(callerName+" " + ex.getLocalizedMessage());
|
392 | 4728 | cesar | } |
393 | } |
||
394 | } |
||
395 | 4516 | cesar | |
396 | 8765 | jjdelcerro | private static void addResourceFamily(String family, Locale lang, HashMap dict) { |
397 | String currentKey;
|
||
398 | Enumeration properties;
|
||
399 | |||
400 | ResourceBundle bundle = null; |
||
401 | |||
402 | try {
|
||
403 | if (!lang.getLanguage().equals("es")) // ensure we don't get a fallback |
||
404 | bundle = ResourceBundle.getBundle(family+"_"+lang.getLanguage(), lang); |
||
405 | else // we allow 'text.properties' to be loaded for Spanish |
||
406 | bundle = ResourceBundle.getBundle(family, lang);
|
||
407 | properties = bundle.getKeys(); |
||
408 | while (properties.hasMoreElements()) {
|
||
409 | currentKey = (String) properties.nextElement();
|
||
410 | if (! dict.containsKey(currentKey)) {
|
||
411 | dict.put(currentKey, bundle.getString(currentKey)); |
||
412 | } |
||
413 | } |
||
414 | } |
||
415 | catch (MissingResourceException ex) { |
||
416 | logger.warn(Messages.class.getName()+" " + ex.getLocalizedMessage());
|
||
417 | } |
||
418 | } |
||
419 | |||
420 | 4728 | cesar | |
421 | 4460 | cesar | /**
|
422 | 5599 | cesar | * Returns an ArrayList containing the ordered list of prefered Locales
|
423 | * Each element of the ArrayList is a Locale object.
|
||
424 | 4460 | cesar | *
|
425 | 5599 | cesar | * @return an ArrayList containing the ordered list of prefered Locales
|
426 | * Each element of the ArrayList is a Locale object.
|
||
427 | 4460 | cesar | */
|
428 | 5599 | cesar | public static ArrayList getPreferredLocales() { |
429 | 5767 | cesar | return preferredLocales;
|
430 | 4460 | cesar | } |
431 | |||
432 | /**
|
||
433 | 5767 | cesar | * <p>Sets the ordered list of preferred locales.
|
434 | * Each element of the ArrayList is a Locale object.</p>
|
||
435 | 4460 | cesar | *
|
436 | 5767 | cesar | * <p>Note that calling this method does not load any translation, it just
|
437 | * adds the language to the preferred locales list, so this method must
|
||
438 | * be always called before the translations are loaded using
|
||
439 | * the addResourceFamily() methods.</p>
|
||
440 | *
|
||
441 | 8765 | jjdelcerro | * <p>It there was any language in the preferred locale list, the language
|
442 | * and its associated translations are deleted.</p>
|
||
443 | *
|
||
444 | *
|
||
445 | 5599 | cesar | * @param preferredLocales an ArrayList containing Locale objects.
|
446 | * The ArrayList represents an ordered list of preferred locales
|
||
447 | 4460 | cesar | */
|
448 | 5767 | cesar | public static void setPreferredLocales(ArrayList preferredLocalesList) { |
449 | 8765 | jjdelcerro | // delete all existing locales
|
450 | Iterator oldLocales = preferredLocales.iterator();
|
||
451 | while (oldLocales.hasNext()) {
|
||
452 | removeLocale((Locale) oldLocales.next());
|
||
453 | } |
||
454 | |||
455 | // add the new locales now
|
||
456 | 5767 | cesar | for (int numLocale=0; numLocale < preferredLocalesList.size(); numLocale++) { |
457 | addLocale((Locale) preferredLocalesList.get(numLocale));
|
||
458 | } |
||
459 | 4460 | cesar | } |
460 | 4728 | cesar | |
461 | /**
|
||
462 | * Adds a Locale at the end of the ordered list of preferred locales.
|
||
463 | 5767 | cesar | * Note that calling this method does not load any translation, it just
|
464 | * adds the language to the preferred locales list, so this method must
|
||
465 | * be always called before the translations are loaded using
|
||
466 | * the addResourceFamily() methods.
|
||
467 | 4728 | cesar | *
|
468 | * @param lang A Locale object specifying the locale to add
|
||
469 | */
|
||
470 | 4516 | cesar | public static void addLocale(Locale lang) { |
471 | 5767 | cesar | if (!preferredLocales.contains(lang)) { // avoid duplicates |
472 | preferredLocales.add(lang); // add the lang to the ordered list of preferred locales
|
||
473 | 8765 | jjdelcerro | HashMap dict = new HashMap(_INITIALSIZE); |
474 | localeResources.add(dict); // add a hashmap which will contain the translation for this language
|
||
475 | addResourceFamily("org.gvsig.i18n.resources.translations.text", lang, dict);
|
||
476 | 4516 | cesar | } |
477 | } |
||
478 | 4728 | cesar | |
479 | /**
|
||
480 | 5767 | cesar | * Removes the specified Locale from the list of preferred locales and the
|
481 | * translations associated with this locale.
|
||
482 | 4728 | cesar | *
|
483 | * @param lang A Locale object specifying the locale to remove
|
||
484 | 5599 | cesar | * @return True if the locale was in the preferred locales list, false otherwise
|
485 | 4728 | cesar | */
|
486 | 4587 | cesar | public static boolean removeLocale(Locale lang) { |
487 | 5767 | cesar | int numLocale = preferredLocales.indexOf(lang);
|
488 | if (numLocale!=-1) { // we found the locale in the list |
||
489 | try {
|
||
490 | preferredLocales.remove(numLocale); |
||
491 | localeResources.remove(numLocale); |
||
492 | } |
||
493 | catch (IndexOutOfBoundsException ex) { |
||
494 | logger.warn(_CLASSNAME + "." + "removeLocale: " + ex.getLocalizedMessage()); |
||
495 | } |
||
496 | return true; |
||
497 | 5599 | cesar | } |
498 | 5767 | cesar | return false; |
499 | 4587 | cesar | } |
500 | 4728 | cesar | |
501 | 4460 | cesar | /**
|
502 | 5767 | cesar | * Cleans the translation tables (removes all the translations from memory).
|
503 | 4728 | cesar | */
|
504 | public static void removeResources() { |
||
505 | 5767 | cesar | for (int numLocale=0; numLocale<localeResources.size(); numLocale++) { |
506 | ((HashMap)localeResources.get(numLocale)).clear();
|
||
507 | } |
||
508 | 4728 | cesar | } |
509 | |||
510 | /**
|
||
511 | * The number of translation keys which have been loaded till now
|
||
512 | * (In other words: the number of available translation strings).
|
||
513 | 5767 | cesar | *
|
514 | * @param lang The language for which we want to know the number of translation keys
|
||
515 | * return The number of translation keys for the provided language.
|
||
516 | 4728 | cesar | */
|
517 | 5767 | cesar | protected static int size(Locale lang) { |
518 | int numLocale = preferredLocales.indexOf(lang);
|
||
519 | if (numLocale!=-1) { |
||
520 | return ((HashMap)localeResources.get(numLocale)).size(); |
||
521 | }; |
||
522 | return 0; |
||
523 | 4728 | cesar | } |
524 | 7241 | cesar | |
525 | 4728 | cesar | /**
|
526 | 7241 | cesar | * Checks if some locale has been added to the preferred locales
|
527 | * list, which is necessary before loading any translation because
|
||
528 | * only the translations for the preferred locales are loaded.
|
||
529 | *
|
||
530 | * @return
|
||
531 | */
|
||
532 | public static boolean hasLocales() { |
||
533 | return preferredLocales.size()>0; |
||
534 | } |
||
535 | |||
536 | /**
|
||
537 | 4460 | cesar | * Searches the subdirectories of the provided directory, finding
|
538 | * all the translation files, and constructing a list of available translations.
|
||
539 | * It reports different country codes or variants, if available.
|
||
540 | * For example, if there is an en_US translation and an en_GB translation, both
|
||
541 | * locales will be present in the Vector.
|
||
542 | *
|
||
543 | * @return
|
||
544 | */
|
||
545 | |||
546 | /**
|
||
547 | *
|
||
548 | * @return A Vector containing the available locales. Each element is a Locale object
|
||
549 | */
|
||
550 | 4728 | cesar | /*public static Vector getAvailableLocales() {
|
551 | 4460 | cesar | return _availableLocales;
|
552 | 4728 | cesar | }*/
|
553 | 4460 | cesar | |
554 | /**
|
||
555 | *
|
||
556 | * @return A Vector containing the available languages. Each element is an String object
|
||
557 | */
|
||
558 | 4728 | cesar | /*public static Vector getAvailableLanguages() {
|
559 | 4460 | cesar | Vector availableLanguages = new Vector();
|
560 | Locale lang;
|
||
561 | Enumeration locales = _availableLocales.elements();
|
||
562 | while (locales.hasMoreElements()) {
|
||
563 | lang = (Locale) locales.nextElement();
|
||
564 | availableLanguages.add(lang.getLanguage());
|
||
565 | }
|
||
566 | return availableLanguages;
|
||
567 | 4728 | cesar | }*/
|
568 | 5767 | cesar | } |