com.liferay.util
Class LocalizationUtil

java.lang.Object
  extended by com.liferay.util.LocalizationUtil

public class LocalizationUtil
extends java.lang.Object

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

Constructor Summary
LocalizationUtil()
           
 
Method Summary
static java.lang.String[] getAvailableLocales(java.lang.String xml)
           
static java.lang.String getDefaultLocale(java.lang.String xml)
           
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.lang.String getPrefsValue(javax.portlet.PortletPreferences prefs, java.lang.String key, java.lang.String languageId)
           
static java.lang.String getPrefsValue(javax.portlet.PortletPreferences prefs, java.lang.String key, java.lang.String languageId, boolean useDefault)
           
static java.lang.String[] getPrefsValues(javax.portlet.PortletPreferences prefs, java.lang.String key, java.lang.String languageId)
           
static java.lang.String[] getPrefsValues(javax.portlet.PortletPreferences prefs, 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 void setPrefsValue(javax.portlet.PortletPreferences prefs, java.lang.String key, java.lang.String languageId, java.lang.String value)
           
static void setPrefsValues(javax.portlet.PortletPreferences prefs, 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)
           
 
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

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 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)

getPrefsValue

public static java.lang.String getPrefsValue(javax.portlet.PortletPreferences prefs,
                                             java.lang.String key,
                                             java.lang.String languageId)

getPrefsValue

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

getPrefsValues

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

getPrefsValues

public static java.lang.String[] getPrefsValues(javax.portlet.PortletPreferences prefs,
                                                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)

setPrefsValue

public static void setPrefsValue(javax.portlet.PortletPreferences prefs,
                                 java.lang.String key,
                                 java.lang.String languageId,
                                 java.lang.String value)
                          throws java.lang.Exception
Throws:
java.lang.Exception

setPrefsValues

public static void setPrefsValues(javax.portlet.PortletPreferences prefs,
                                  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)