com.liferay.portal.util
Class LocalizationImpl

java.lang.Object
  extended by com.liferay.portal.util.LocalizationImpl
All Implemented Interfaces:
com.liferay.portal.kernel.util.Localization

public class LocalizationImpl
extends java.lang.Object
implements com.liferay.portal.kernel.util.Localization

View Source

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
LocalizationImpl()
           
 
Method Summary
 java.lang.Object deserialize(com.liferay.portal.kernel.json.JSONObject jsonObject)
           
 java.lang.String[] getAvailableLocales(java.lang.String xml)
           
 java.lang.String getDefaultLocale(java.lang.String xml)
           
 java.lang.String getLocalization(java.lang.String xml, java.lang.String requestedLanguageId)
           
 java.lang.String getLocalization(java.lang.String xml, java.lang.String requestedLanguageId, boolean useDefault)
           
 java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(javax.portlet.PortletRequest portletRequest, java.lang.String parameter)
           
 java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(java.lang.String xml)
           
 java.util.Map<java.util.Locale,java.lang.String> getLocalizedParameter(javax.portlet.PortletRequest portletRequest, java.lang.String parameter)
          Deprecated. Use getLocalizationMap.
 java.lang.String getPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId)
           
 java.lang.String getPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, boolean useDefault)
           
 java.lang.String[] getPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId)
           
 java.lang.String[] getPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, boolean useDefault)
           
 java.lang.String removeLocalization(java.lang.String xml, java.lang.String key, java.lang.String requestedLanguageId)
           
 java.lang.String removeLocalization(java.lang.String xml, java.lang.String key, java.lang.String requestedLanguageId, boolean cdata)
           
 void setLocalizedPreferencesValues(javax.portlet.ActionRequest actionRequest, javax.portlet.PortletPreferences preferences, java.lang.String parameter)
           
 void setPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, java.lang.String value)
           
 void setPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, java.lang.String[] values)
           
 java.lang.String updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value)
           
 java.lang.String updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value, java.lang.String requestedLanguageId)
           
 java.lang.String updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value, java.lang.String requestedLanguageId, java.lang.String defaultLanguageId)
           
 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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LocalizationImpl

public LocalizationImpl()
Method Detail

deserialize

public java.lang.Object deserialize(com.liferay.portal.kernel.json.JSONObject jsonObject)
Specified by:
deserialize in interface com.liferay.portal.kernel.util.Localization

getAvailableLocales

public java.lang.String[] getAvailableLocales(java.lang.String xml)
Specified by:
getAvailableLocales in interface com.liferay.portal.kernel.util.Localization

getDefaultLocale

public java.lang.String getDefaultLocale(java.lang.String xml)
Specified by:
getDefaultLocale in interface com.liferay.portal.kernel.util.Localization

getLocalization

public java.lang.String getLocalization(java.lang.String xml,
                                        java.lang.String requestedLanguageId)
Specified by:
getLocalization in interface com.liferay.portal.kernel.util.Localization

getLocalization

public java.lang.String getLocalization(java.lang.String xml,
                                        java.lang.String requestedLanguageId,
                                        boolean useDefault)
Specified by:
getLocalization in interface com.liferay.portal.kernel.util.Localization

getLocalizationMap

public java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(javax.portlet.PortletRequest portletRequest,
                                                                           java.lang.String parameter)
Specified by:
getLocalizationMap in interface com.liferay.portal.kernel.util.Localization

getLocalizationMap

public java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(java.lang.String xml)
Specified by:
getLocalizationMap in interface com.liferay.portal.kernel.util.Localization

getLocalizedParameter

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

Specified by:
getLocalizedParameter in interface com.liferay.portal.kernel.util.Localization

getPreferencesValue

public java.lang.String getPreferencesValue(javax.portlet.PortletPreferences preferences,
                                            java.lang.String key,
                                            java.lang.String languageId)
Specified by:
getPreferencesValue in interface com.liferay.portal.kernel.util.Localization

getPreferencesValue

public java.lang.String getPreferencesValue(javax.portlet.PortletPreferences preferences,
                                            java.lang.String key,
                                            java.lang.String languageId,
                                            boolean useDefault)
Specified by:
getPreferencesValue in interface com.liferay.portal.kernel.util.Localization

getPreferencesValues

public java.lang.String[] getPreferencesValues(javax.portlet.PortletPreferences preferences,
                                               java.lang.String key,
                                               java.lang.String languageId)
Specified by:
getPreferencesValues in interface com.liferay.portal.kernel.util.Localization

getPreferencesValues

public java.lang.String[] getPreferencesValues(javax.portlet.PortletPreferences preferences,
                                               java.lang.String key,
                                               java.lang.String languageId,
                                               boolean useDefault)
Specified by:
getPreferencesValues in interface com.liferay.portal.kernel.util.Localization

removeLocalization

public java.lang.String removeLocalization(java.lang.String xml,
                                           java.lang.String key,
                                           java.lang.String requestedLanguageId)
Specified by:
removeLocalization in interface com.liferay.portal.kernel.util.Localization

removeLocalization

public java.lang.String removeLocalization(java.lang.String xml,
                                           java.lang.String key,
                                           java.lang.String requestedLanguageId,
                                           boolean cdata)
Specified by:
removeLocalization in interface com.liferay.portal.kernel.util.Localization

setLocalizedPreferencesValues

public void setLocalizedPreferencesValues(javax.portlet.ActionRequest actionRequest,
                                          javax.portlet.PortletPreferences preferences,
                                          java.lang.String parameter)
                                   throws java.lang.Exception
Specified by:
setLocalizedPreferencesValues in interface com.liferay.portal.kernel.util.Localization
Throws:
java.lang.Exception

setPreferencesValue

public void setPreferencesValue(javax.portlet.PortletPreferences preferences,
                                java.lang.String key,
                                java.lang.String languageId,
                                java.lang.String value)
                         throws java.lang.Exception
Specified by:
setPreferencesValue in interface com.liferay.portal.kernel.util.Localization
Throws:
java.lang.Exception

setPreferencesValues

public void setPreferencesValues(javax.portlet.PortletPreferences preferences,
                                 java.lang.String key,
                                 java.lang.String languageId,
                                 java.lang.String[] values)
                          throws java.lang.Exception
Specified by:
setPreferencesValues in interface com.liferay.portal.kernel.util.Localization
Throws:
java.lang.Exception

updateLocalization

public java.lang.String updateLocalization(java.lang.String xml,
                                           java.lang.String key,
                                           java.lang.String value)
Specified by:
updateLocalization in interface com.liferay.portal.kernel.util.Localization

updateLocalization

public java.lang.String updateLocalization(java.lang.String xml,
                                           java.lang.String key,
                                           java.lang.String value,
                                           java.lang.String requestedLanguageId)
Specified by:
updateLocalization in interface com.liferay.portal.kernel.util.Localization

updateLocalization

public java.lang.String updateLocalization(java.lang.String xml,
                                           java.lang.String key,
                                           java.lang.String value,
                                           java.lang.String requestedLanguageId,
                                           java.lang.String defaultLanguageId)
Specified by:
updateLocalization in interface com.liferay.portal.kernel.util.Localization

updateLocalization

public 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)
Specified by:
updateLocalization in interface com.liferay.portal.kernel.util.Localization