com.liferay.portal.kernel.util
Interface Localization


public interface 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

Method Summary
 java.lang.Object deserialize(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)
           
 

Method Detail

deserialize

java.lang.Object deserialize(JSONObject jsonObject)

getAvailableLocales

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

getDefaultLocale

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

getLocalization

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

getLocalization

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

getLocalizationMap

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

getLocalizationMap

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

getLocalizedParameter

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


getPreferencesValue

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

getPreferencesValue

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

getPreferencesValues

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

getPreferencesValues

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

removeLocalization

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

removeLocalization

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

setLocalizedPreferencesValues

void setLocalizedPreferencesValues(javax.portlet.ActionRequest actionRequest,
                                   javax.portlet.PortletPreferences preferences,
                                   java.lang.String parameter)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

setPreferencesValue

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

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

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

updateLocalization

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

updateLocalization

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

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)