com.liferay.portal.kernel.util
Class LocalizationUtil

java.lang.Object
  com.liferay.portal.kernel.util.LocalizationUtil

public class LocalizationUtil
extends java.lang.Object

This class is used to localize values stored in XML and is often used to add localization behavior to value objects.

Caching of the localized values is done in this class rather than in the value object since value objects get flushed from cache fairly quickly. Though lookups performed on a key based on an XML file is slower than lookups done at the value object level in general, the value object will get flushed at a rate which works against the performance gain. The cache is a soft hash map which prevents memory leaks within the system while enabling the cache to live longer than in a weak hash map.

Author:

Alexander Chow, Jorge Ferrer, Mauro Mariuzzo, Julio Camarero, Brian Wing Shun Chan

Constructor Summary

LocalizationUtil()

Method Summary

static java.lang.Object	deserialize(JSONObject jsonObject)
static java.lang.String[]	getAvailableLocales(java.lang.String xml)
static java.lang.String	getDefaultLocale(java.lang.String xml)
static Localization	getLocalization()
static java.lang.String	getLocalization(java.lang.String xml, java.lang.String requestedLanguageId)
static java.lang.String	getLocalization(java.lang.String xml, java.lang.String requestedLanguageId, boolean useDefault)
static java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(javax.portlet.PortletRequest portletRequest, java.lang.String parameter)
static java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(java.lang.String xml)
static java.lang.String	getLocalizationXmlFromPreferences(javax.portlet.PortletPreferences preferences, javax.portlet.PortletRequest portletRequest, java.lang.String parameter)
static java.util.Map<java.util.Locale,java.lang.String>	getLocalizedParameter(javax.portlet.PortletRequest portletRequest, java.lang.String parameter) Deprecated. Use getLocalizationMap.
static java.lang.String	getPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId)
static java.lang.String	getPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, boolean useDefault)
static java.lang.String[]	getPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId)
static java.lang.String[]	getPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, boolean useDefault)
static java.lang.String	removeLocalization(java.lang.String xml, java.lang.String key, java.lang.String requestedLanguageId)
static java.lang.String	removeLocalization(java.lang.String xml, java.lang.String key, java.lang.String requestedLanguageId, boolean cdata)
static java.lang.String	removeLocalization(java.lang.String xml, java.lang.String key, java.lang.String requestedLanguageId, boolean cdata, boolean localized)
void	setLocalization(Localization localization)
static void	setLocalizedPreferencesValues(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences preferences, java.lang.String parameter)
static void	setPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, java.lang.String value)
static void	setPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, java.lang.String[] values)
static java.lang.String	updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value)
static java.lang.String	updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value, java.lang.String requestedLanguageId)
static java.lang.String	updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value, java.lang.String requestedLanguageId, java.lang.String defaultLanguageId)
static java.lang.String	updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value, java.lang.String requestedLanguageId, java.lang.String defaultLanguageId, boolean cdata)
static java.lang.String	updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value, java.lang.String requestedLanguageId, java.lang.String defaultLanguageId, boolean cdata, boolean localized)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalizationUtil

public LocalizationUtil()

Method Detail

deserialize

public static java.lang.Object deserialize(JSONObject jsonObject)

getAvailableLocales

public static java.lang.String[] getAvailableLocales(java.lang.String xml)

getDefaultLocale

public static java.lang.String getDefaultLocale(java.lang.String xml)

getLocalization

public static Localization getLocalization()

getLocalization

public static java.lang.String getLocalization(java.lang.String xml,
                                               java.lang.String requestedLanguageId)

getLocalization

public static java.lang.String getLocalization(java.lang.String xml,
                                               java.lang.String requestedLanguageId,
                                               boolean useDefault)

getLocalizationMap

public static java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(javax.portlet.PortletRequest portletRequest,
                                                                                  java.lang.String parameter)

getLocalizationMap

public static java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(java.lang.String xml)

getLocalizationXmlFromPreferences

public static java.lang.String getLocalizationXmlFromPreferences(javax.portlet.PortletPreferences preferences,
                                                                 javax.portlet.PortletRequest portletRequest,
                                                                 java.lang.String parameter)

getLocalizedParameter

public static java.util.Map<java.util.Locale,java.lang.String> getLocalizedParameter(javax.portlet.PortletRequest portletRequest,
                                                                                     java.lang.String parameter)

Deprecated. Use getLocalizationMap.

getPreferencesValue

public static java.lang.String getPreferencesValue(javax.portlet.PortletPreferences preferences,
                                                   java.lang.String key,
                                                   java.lang.String languageId)

getPreferencesValue

public static java.lang.String getPreferencesValue(javax.portlet.PortletPreferences preferences,
                                                   java.lang.String key,
                                                   java.lang.String languageId,
                                                   boolean useDefault)

getPreferencesValues

public static java.lang.String[] getPreferencesValues(javax.portlet.PortletPreferences preferences,
                                                      java.lang.String key,
                                                      java.lang.String languageId)

getPreferencesValues

public static java.lang.String[] getPreferencesValues(javax.portlet.PortletPreferences preferences,
                                                      java.lang.String key,
                                                      java.lang.String languageId,
                                                      boolean useDefault)

removeLocalization

public static java.lang.String removeLocalization(java.lang.String xml,
                                                  java.lang.String key,
                                                  java.lang.String requestedLanguageId)

removeLocalization

public static java.lang.String removeLocalization(java.lang.String xml,
                                                  java.lang.String key,
                                                  java.lang.String requestedLanguageId,
                                                  boolean cdata)

removeLocalization

public static java.lang.String removeLocalization(java.lang.String xml,
                                                  java.lang.String key,
                                                  java.lang.String requestedLanguageId,
                                                  boolean cdata,
                                                  boolean localized)

setLocalizedPreferencesValues

public static void setLocalizedPreferencesValues(javax.portlet.PortletRequest portletRequest,
                                                 javax.portlet.PortletPreferences preferences,
                                                 java.lang.String parameter)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

setPreferencesValue

public static void setPreferencesValue(javax.portlet.PortletPreferences preferences,
                                       java.lang.String key,
                                       java.lang.String languageId,
                                       java.lang.String value)
                                throws java.lang.Exception

Throws:

java.lang.Exception

setPreferencesValues

public static void setPreferencesValues(javax.portlet.PortletPreferences preferences,
                                        java.lang.String key,
                                        java.lang.String languageId,
                                        java.lang.String[] values)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

updateLocalization

public static java.lang.String updateLocalization(java.lang.String xml,
                                                  java.lang.String key,
                                                  java.lang.String value)

updateLocalization

public static java.lang.String updateLocalization(java.lang.String xml,
                                                  java.lang.String key,
                                                  java.lang.String value,
                                                  java.lang.String requestedLanguageId)

updateLocalization

public static java.lang.String updateLocalization(java.lang.String xml,
                                                  java.lang.String key,
                                                  java.lang.String value,
                                                  java.lang.String requestedLanguageId,
                                                  java.lang.String defaultLanguageId)

updateLocalization

public static java.lang.String updateLocalization(java.lang.String xml,
                                                  java.lang.String key,
                                                  java.lang.String value,
                                                  java.lang.String requestedLanguageId,
                                                  java.lang.String defaultLanguageId,
                                                  boolean cdata)

updateLocalization

public static java.lang.String updateLocalization(java.lang.String xml,
                                                  java.lang.String key,
                                                  java.lang.String value,
                                                  java.lang.String requestedLanguageId,
                                                  java.lang.String defaultLanguageId,
                                                  boolean cdata,
                                                  boolean localized)

setLocalization

public void setLocalization(Localization localization)