com.fathzer.soft.ajlib.utilities.LocalizationData Maven / Gradle / Ivy

Go to download
package com.fathzer.soft.ajlib.utilities;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.ResourceBundle;

/** This class is the main entry point for localization concerns.
 * @author Jean-Marc Astesana
 * 
License: LGPL v3
 */
public class LocalizationData {
	public static final String DEFAULT_BUNDLE_NAME = "com.fathzer.soft.ajlib.Resources";
	public static LocalizationData DEFAULT = new LocalizationData(DEFAULT_BUNDLE_NAME);
	
	private Map> bundles;
	private List bundleNames;
	private boolean translatorMode;
	
	public static Locale getSystemLocale() {
		try {
			return new Locale(System.getProperty("user.language"), System.getProperty("user.country")); //$NON-NLS-1$ //$NON-NLS-2$
		} catch (SecurityException e) {
			return Locale.getDefault();
		}
	}
	
	/** Constructor.
	 * @param bundlePath The main bundlePath
	 * @see #add(String)
	 */
	public LocalizationData(String bundlePath) {
		this.bundleNames = new ArrayList();
		this.bundleNames.add(bundlePath);
		this.bundles = new HashMap>();
		this.translatorMode = false;
	}
	
	/** Adds a bundle path to this.
	 * 
The application wordings may not be all in the same bundle. This method allows you to declare additional bundles.
	 * 
If a key is present in two or more bundles, the last added has the priority and its wording will be returned by getString methods.
	 * This allows developers to redefine some wordings.
	 * @param bundlePath
	 */
	public void add(String bundlePath) {
		for(Locale locale : bundles.keySet()) {
			List bundles = this.bundles.get(locale);
			bundles.add(ResourceBundle.getBundle(bundlePath, locale));
		}
		this.bundleNames.add(bundlePath);
	}
	
	/** Gets a wording for a locale.
	 * @param key The wording's key
	 * @param locale The locale.

	 * Please note that the standard strategy may cause "strange behavior". Here is an example:

	 * Let say that the default locale is fr_FR and we ask for the en_US locale, and we have define two bundles:
	 * The default one with no extension, that contains English wordings
	 * The French one (_fr extension).
	 * In such a case, the loaded bundle for en_US locale will be the French one, and not the default one !
	 * It is because Locale.getDefault() bundle has priority on the default bundle (see {@link ResourceBundle#getBundle(String)}) for more information).
	 * 
A work-around is to always set the default locale (see {@link Locale#setDefault(Locale)}) to the desired locale.
	 * @return The wording
	 * @throws MissingResourceException if the key is unknown 
	 */
	public String getString(String key, Locale locale) {
		// If translator mode is on, return the key
		if (translatorMode) {
			return key;
		}
		// Check key in additional bundles
		List bundle = this.getBundle(locale);
		for (int i = bundle.size()-1; i > 0; i--) {
			if (bundle.get(i).containsKey(key)) {
				return bundle.get(i).getString(key);
			}
		}
		return bundle.get(0).getString(key);
	}
	
	/** Gets a wording for default locale.
	 * 
Same as getString(key, Locale.getDefault())
	 * @param key The wording's key
	 * @return a String
	 * @throws MissingResourceException if the key is unknown
	 * @see #getString(String, Locale)
	 */
	public String getString(String key) {
		return getString(key, Locale.getDefault());
	}
	
	private List getBundle(Locale locale) {
		List result = bundles.get(locale);
		if (result==null) {
//			System.out.println ("Loading bundle for locale "+locale);
			result = new ArrayList();
			for (String bundleName : this.bundleNames) {
				ResourceBundle bundle = ResourceBundle.getBundle(bundleName, locale);
//				System.out.println ("  ->"+bundle.getLocale());
				result.add(bundle);
			}
			bundles.put(locale, result);
		}
		return result;
	}
	
	public void setTranslatorMode(boolean translatorMode) {
		this.translatorMode = translatorMode; 
	}
}