com.liferay.portal.kernel.util

Interface Localization

@ProviderType
public interface Localization

Stores and retrieves localized strings from XML, and provides utility methods for updating localizations from JSON, portlet requests, and maps. Used for adding localization to strings, most often for model properties.

Localized values are cached 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 are 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

Modifier and Type	Method and Description
java.lang.Object	deserialize(JSONObject jsonObject) Deserializes the JSON object into a map of locales and localized strings.
java.lang.String[]	getAvailableLanguageIds(Document document)
java.lang.String[]	getAvailableLanguageIds(java.lang.String xml) Returns the available locales from the localizations XML.
java.util.Locale	getDefaultImportLocale(java.lang.String className, long classPK, java.util.Locale contentDefaultLocale, java.util.Locale[] contentAvailableLocales) Returns a valid default locale for importing a localized entity.
java.util.Locale	getDefaultImportLocale(java.lang.String className, java.io.Serializable primaryKey, java.util.Locale contentDefaultLocale, java.util.Locale[] contentAvailableLocales) Returns a valid default locale for importing a localized entity.
java.lang.String	getDefaultLanguageId(Document document)
java.lang.String	getDefaultLanguageId(Document document, java.util.Locale defaultLocale)
java.lang.String	getDefaultLanguageId(java.lang.String xml) Returns the default locale from the localizations XML.
java.lang.String	getDefaultLanguageId(java.lang.String xml, java.util.Locale defaultLocale)
java.lang.String	getLocalization(java.util.function.Function<java.lang.String,java.lang.String> localizationFunction, java.lang.String requestedLanguageId, java.lang.String defaultLanguageId)
java.lang.String	getLocalization(java.lang.String xml, java.lang.String requestedLanguageId) Returns the localized string from the localizations XML in the language.
java.lang.String	getLocalization(java.lang.String xml, java.lang.String requestedLanguageId, boolean useDefault) Returns the localized string from the localizations XML in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getLocalization(java.lang.String xml, java.lang.String requestedLanguageId, boolean useDefault, java.lang.String defaultValue) Returns the localized string from the localizations XML in the language, optionally using the default language if no localization exists for the requested language.
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(java.util.Collection<java.util.Locale> locales, java.util.Locale defaultLocale, java.lang.String key) Returns a map of locales and localized strings for the key.
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String parameter) Returns a map of locales and localized strings for the parameter in the request.
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(javax.portlet.PortletPreferences preferences, java.lang.String preferenceName) Returns a map of locales and localized strings for the preference in the preferences container.
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(javax.portlet.PortletPreferences preferences, java.lang.String preferenceName, java.lang.String propertyName) Returns a map of locales and localized strings for the preference in the preferences container.
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(javax.portlet.PortletPreferences preferences, java.lang.String preferenceName, java.lang.String propertyName, java.lang.String defaultPropertyValue, java.lang.ClassLoader classLoader)
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(javax.portlet.PortletRequest portletRequest, java.lang.String parameter) Returns a map of locales and localized strings for the parameter in the portlet request.
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> defaultValues)
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(java.lang.String xml) Returns a map of locales and localized strings from the localizations XML.
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(java.lang.String[] languageIds, java.lang.String[] values) Returns a map of locales and localized strings for the given languageIds and values.
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(java.lang.String xml, boolean useDefault)
java.util.Map<java.util.Locale,java.lang.String>	getLocalizationMap(java.lang.String bundleName, java.lang.ClassLoader classLoader, java.lang.String key, boolean includeBetaLocales)
java.lang.String	getLocalizationXmlFromPreferences(javax.portlet.PortletPreferences preferences, javax.portlet.PortletRequest portletRequest, java.lang.String parameter) Returns the localizations XML for the parameter from the portlet request, attempting to get data from the preferences container if it is not available in the portlet request.
java.lang.String	getLocalizationXmlFromPreferences(javax.portlet.PortletPreferences preferences, javax.portlet.PortletRequest portletRequest, java.lang.String parameter, java.lang.String defaultValue) Returns the localizations XML for the parameter from the portlet request, attempting to get data from the preferences container if it is not available in the portlet request.
java.lang.String	getLocalizationXmlFromPreferences(javax.portlet.PortletPreferences preferences, javax.portlet.PortletRequest portletRequest, java.lang.String parameter, java.lang.String prefix, java.lang.String defaultValue) Returns the localizations XML for the prefixed parameter from the portlet request, attempting to get data from the preferences container if it is not available in the portlet request.
java.lang.String	getLocalizedName(java.lang.String name, java.lang.String languageId) Returns the localized name in the language.
java.util.Map<java.util.Locale,java.lang.String>	getMap(LocalizedValuesMap localizedValuesMap)
java.lang.String	getPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId) Returns the localized preferences value for the key in the language.
java.lang.String	getPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, boolean useDefault) Returns the localized preferences value for the key in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String[]	getPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId) Returns the localized preferences values for the key in the language.
java.lang.String[]	getPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, boolean useDefault) Returns the localized preferences values for the key in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getSettingsValue(Settings settings, java.lang.String key, java.lang.String languageId) Returns the localized settings value for the key in the language.
java.lang.String	getSettingsValue(Settings settings, java.lang.String key, java.lang.String languageId, boolean useDefault) Returns the localized settings value for the key in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String[]	getSettingsValues(Settings settings, java.lang.String key, java.lang.String languageId) Returns the localized settings values for the key in the language.
java.lang.String[]	getSettingsValues(Settings settings, java.lang.String key, java.lang.String languageId, boolean useDefault) Returns the localized settings values for the key in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getXml(LocalizedValuesMap localizedValuesMap, java.lang.String key)
java.lang.String	getXml(java.util.Map<java.lang.String,java.lang.String> map, java.lang.String defaultLanguageId, java.lang.String key)
java.util.Map<java.util.Locale,java.lang.String>	populateLocalizationMap(java.util.Map<java.util.Locale,java.lang.String> localizationMap, java.lang.String defaultLanguageId, long groupId)
java.lang.String	removeLocalization(java.lang.String xml, java.lang.String key, java.lang.String requestedLanguageId) Removes the localization for the language from the localizations XML.
java.lang.String	removeLocalization(java.lang.String xml, java.lang.String key, java.lang.String requestedLanguageId, boolean cdata) Removes the localization for the language from the localizations XML, optionally storing the localized strings as CDATA in the XML.
java.lang.String	removeLocalization(java.lang.String xml, java.lang.String key, java.lang.String requestedLanguageId, boolean cdata, boolean localized) Removes the localization for the language from the localizations XML, optionally storing the localized strings as CDATA in the XML.
void	setLocalizedPreferencesValues(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences preferences, java.lang.String parameter) Sets the localized preferences values for the parameter in the portlet request.
void	setPreferencesValue(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, java.lang.String value) Sets the localized preferences value for the key in the language.
void	setPreferencesValues(javax.portlet.PortletPreferences preferences, java.lang.String key, java.lang.String languageId, java.lang.String[] values) Sets the localized preferences values for the key in the language.
java.lang.String	updateLocalization(java.util.Map<java.util.Locale,java.lang.String> localizationMap, java.lang.String xml, java.lang.String key, java.lang.String defaultLanguageId) Updates the localized string for all the available languages in the localizations XML for the map of locales and localized strings and changes the default language.
java.lang.String	updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value) Updates the localized string for the system default language in the localizations XML.
java.lang.String	updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value, java.lang.String requestedLanguageId) Updates the localized string for the language in the localizations XML.
java.lang.String	updateLocalization(java.lang.String xml, java.lang.String key, java.lang.String value, java.lang.String requestedLanguageId, java.lang.String defaultLanguageId) Updates the localized string for the language in the localizations XML and changes the default language.
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) Updates the localized string for the language in the localizations XML and changes the default language, optionally storing the localized strings as CDATA in the XML.
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) Updates the localized string for the language in the localizations XML and changes the default language, optionally storing the localized strings as CDATA in the XML.

Method Detail

deserialize

java.lang.Object deserialize(JSONObject jsonObject)

Deserializes the JSON object into a map of locales and localized strings.

Parameters:

jsonObject - the JSON object

Returns:

the locales and localized strings

getAvailableLanguageIds

java.lang.String[] getAvailableLanguageIds(Document document)

getAvailableLanguageIds

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

Returns the available locales from the localizations XML.

Parameters:

xml - the localizations XML

Returns:

the language IDs of the available locales

getDefaultImportLocale

java.util.Locale getDefaultImportLocale(java.lang.String className,
                                        long classPK,
                                        java.util.Locale contentDefaultLocale,
                                        java.util.Locale[] contentAvailableLocales)

Returns a valid default locale for importing a localized entity.

Parameters:

className - the class name of the entity

classPK - the primary keys of the entity

contentDefaultLocale - the default Locale of the entity

contentAvailableLocales - the available locales of the entity

Returns:

the valid locale

getDefaultImportLocale

java.util.Locale getDefaultImportLocale(java.lang.String className,
                                        java.io.Serializable primaryKey,
                                        java.util.Locale contentDefaultLocale,
                                        java.util.Locale[] contentAvailableLocales)

Returns a valid default locale for importing a localized entity.

Parameters:

className - the class name of the entity

primaryKey - the primary keys of the entity

contentDefaultLocale - the default Locale of the entity

contentAvailableLocales - the available locales of the entity

Returns:

the valid locale

getDefaultLanguageId

java.lang.String getDefaultLanguageId(Document document)

getDefaultLanguageId

java.lang.String getDefaultLanguageId(Document document,
                                      java.util.Locale defaultLocale)

getDefaultLanguageId

java.lang.String getDefaultLanguageId(java.lang.String xml)

Returns the default locale from the localizations XML.

Parameters:

xml - the localizations XML

Returns:

the language ID of the default locale, or the system default locale if the default locale cannot be retrieved from the XML

getDefaultLanguageId

java.lang.String getDefaultLanguageId(java.lang.String xml,
                                      java.util.Locale defaultLocale)

getLocalization

java.lang.String getLocalization(java.util.function.Function<java.lang.String,java.lang.String> localizationFunction,
                                 java.lang.String requestedLanguageId,
                                 java.lang.String defaultLanguageId)

getLocalization

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

Returns the localized string from the localizations XML in the language. The default language is used if no localization exists for the requested language.

Parameters:

xml - the localizations XML

requestedLanguageId - the ID of the language

Returns:

the localized string

getLocalization

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

Returns the localized string from the localizations XML in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

xml - the localizations XML

requestedLanguageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized string, or an empty string if useDefault is false and no localization exists for the requested language

getLocalization

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

Returns the localized string from the localizations XML in the language, optionally using the default language if no localization exists for the requested language. If no localization exists, the default value is returned.

Parameters:

xml - the localizations XML

requestedLanguageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

defaultValue - the value returned if no localization exists

Returns:

the localized string, or the defaultValue if useDefault is false and no localization exists for the requested language

getLocalizationMap

java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(java.util.Collection<java.util.Locale> locales,
                                                                    java.util.Locale defaultLocale,
                                                                    java.lang.String key)

Returns a map of locales and localized strings for the key. If no localization exists for a locale or the localization matches the default locale, that locale is not included in the map.

Parameters:

locales - the locales to be used in the map

defaultLocale - the default locale

key - the language key to be translated

Returns:

the locales and localized strings for the key

getLocalizationMap

java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                    java.lang.String parameter)

Returns a map of locales and localized strings for the parameter in the request.

Parameters:

httpServletRequest - the request

parameter - the prefix of the parameters containing the localized strings. Each localization is loaded from a parameter with this prefix, followed by an underscore, and the language ID.

Returns:

the locales and localized strings

getLocalizationMap

java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(javax.portlet.PortletPreferences preferences,
                                                                    java.lang.String preferenceName)

Returns a map of locales and localized strings for the preference in the preferences container.

Parameters:

preferences - the preferences container

preferenceName - the prefix of the preference containing the localized strings. Each localization is loaded from a preference with this prefix, followed by an underscore, and the language ID.

Returns:

the locales and localized strings

getLocalizationMap

java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(javax.portlet.PortletPreferences preferences,
                                                                    java.lang.String preferenceName,
                                                                    java.lang.String propertyName)

Returns a map of locales and localized strings for the preference in the preferences container. If no localization exists for the preference in the default locale, the value of the property is used as the localization for it.

Parameters:

preferences - the preferences container

preferenceName - the prefix of the preference containing the localized strings. Each localization is loaded from a preference with this prefix, followed by an underscore, and the language ID.

propertyName - the name of the property whose value is used as the localization for the default locale, if no localization exists for it

Returns:

the locales and localized strings

getLocalizationMap

java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(javax.portlet.PortletPreferences preferences,
                                                                    java.lang.String preferenceName,
                                                                    java.lang.String propertyName,
                                                                    java.lang.String defaultPropertyValue,
                                                                    java.lang.ClassLoader classLoader)

getLocalizationMap

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

Returns a map of locales and localized strings for the parameter in the portlet request.

Parameters:

portletRequest - the portlet request

parameter - the prefix of the parameters containing the localized strings. Each localization is loaded from a parameter with this prefix, followed by an underscore, and the language ID.

Returns:

the locales and localized strings

getLocalizationMap

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

getLocalizationMap

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

Returns a map of locales and localized strings from the localizations XML.

Parameters:

xml - the localizations XML

Returns:

the locales and localized strings

getLocalizationMap

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

getLocalizationMap

java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(java.lang.String bundleName,
                                                                    java.lang.ClassLoader classLoader,
                                                                    java.lang.String key,
                                                                    boolean includeBetaLocales)

getLocalizationMap

java.util.Map<java.util.Locale,java.lang.String> getLocalizationMap(java.lang.String[] languageIds,
                                                                    java.lang.String[] values)

Returns a map of locales and localized strings for the given languageIds and values.

Parameters:

languageIds - the languageIds of the localized Strings

values - the localized strings for the different languageId

Returns:

the map of locales and values for the given parameters

getLocalizationXmlFromPreferences

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

Returns the localizations XML for the parameter from the portlet request, attempting to get data from the preferences container if it is not available in the portlet request.

Parameters:

preferences - the preferences container

portletRequest - the portlet request

parameter - the prefix of the parameters containing the localized strings. Each localization is loaded from a parameter with this prefix, followed by an underscore, and the language ID.

Returns:

the locales and localized strings

getLocalizationXmlFromPreferences

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

Returns the localizations XML for the parameter from the portlet request, attempting to get data from the preferences container if it is not available in the portlet request. If no localization exists in the default locale, the default value is used as the localization for it.

Parameters:

preferences - the preferences container

portletRequest - the portlet request

parameter - the prefix of the parameters containing the localized strings. Each localization is loaded from a parameter with this prefix, followed by an underscore, and the language ID.

defaultValue - the value used as the localization for the default locale, if no localization exists for it

Returns:

the locales and localized strings

getLocalizationXmlFromPreferences

java.lang.String getLocalizationXmlFromPreferences(javax.portlet.PortletPreferences preferences,
                                                   javax.portlet.PortletRequest portletRequest,
                                                   java.lang.String parameter,
                                                   java.lang.String prefix,
                                                   java.lang.String defaultValue)

Returns the localizations XML for the prefixed parameter from the portlet request, attempting to get data from the preferences container if it is not available in the portlet request. If no localization exists for the the default locale, the default value is used as the localization for it.

Parameters:

preferences - the preferences container

portletRequest - the portlet request

parameter - the prefix of the parameters containing the localized strings. Each localization is loaded from a parameter with this prefix, followed by an underscore, and the language ID.

prefix - the value used in the request to prefix the parameter name

defaultValue - the value used as the localization for the default locale, if no localization exists for it

Returns:

the locales and localized strings, or the defaultValue if no localization exists

getLocalizedName

java.lang.String getLocalizedName(java.lang.String name,
                                  java.lang.String languageId)

Returns the localized name in the language. The localized name is the name, followed by an underscore, and the language ID.

Parameters:

name - the name to be localized

languageId - the ID of the language

Returns:

the localized name for the language

getMap

java.util.Map<java.util.Locale,java.lang.String> getMap(LocalizedValuesMap localizedValuesMap)

getPreferencesValue

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

Returns the localized preferences value for the key in the language. The default language is used if no localization exists for the requested language.

Parameters:

preferences - the preferences container

key - the preferences key

languageId - the ID of the language

Returns:

the localized preferences value

getPreferencesValue

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

Returns the localized preferences value for the key in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

preferences - the preferences container

key - the preferences key

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized preferences value, or an empty string if useDefault is false and no localization exists for the requested language

getPreferencesValues

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

Returns the localized preferences values for the key in the language. The default language is used if no localization exists for the requested language.

Parameters:

preferences - the preferences container

key - the preferences key

languageId - the ID of the language

Returns:

the localized preferences values

getPreferencesValues

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

Returns the localized preferences values for the key in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

preferences - the preferences container

key - the preferences key

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized preferences values, or an empty string if useDefault is false and no localization exists for the requested language

getSettingsValue

java.lang.String getSettingsValue(Settings settings,
                                  java.lang.String key,
                                  java.lang.String languageId)

Returns the localized settings value for the key in the language. The default language is used if no localization exists for the requested language.

Parameters:

settings - the settings

key - the settings key

languageId - the ID of the language

Returns:

the localized settings value

getSettingsValue

java.lang.String getSettingsValue(Settings settings,
                                  java.lang.String key,
                                  java.lang.String languageId,
                                  boolean useDefault)

Returns the localized settings value for the key in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

settings - the settings

key - the settings key

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized settings value. If useDefault is false and no localization exists for the requested language, an empty string is returned.

getSettingsValues

java.lang.String[] getSettingsValues(Settings settings,
                                     java.lang.String key,
                                     java.lang.String languageId)

Returns the localized settings values for the key in the language. The default language is used if no localization exists for the requested language.

Parameters:

settings - the settings

key - the settings key

languageId - the ID of the language

Returns:

the localized settings values

getSettingsValues

java.lang.String[] getSettingsValues(Settings settings,
                                     java.lang.String key,
                                     java.lang.String languageId,
                                     boolean useDefault)

Returns the localized settings values for the key in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

settings - the settings

key - the settings key

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized settings values. If useDefault is false and no localization exists for the requested language, an empty array is returned.

getXml

java.lang.String getXml(LocalizedValuesMap localizedValuesMap,
                        java.lang.String key)

getXml

java.lang.String getXml(java.util.Map<java.lang.String,java.lang.String> map,
                        java.lang.String defaultLanguageId,
                        java.lang.String key)

populateLocalizationMap

java.util.Map<java.util.Locale,java.lang.String> populateLocalizationMap(java.util.Map<java.util.Locale,java.lang.String> localizationMap,
                                                                         java.lang.String defaultLanguageId,
                                                                         long groupId)

removeLocalization

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

Removes the localization for the language from the localizations XML. The localized strings are stored as characters in the XML.

Parameters:

xml - the localizations XML

key - the name of the localized string, such as "Title"

requestedLanguageId - the ID of the language

Returns:

the localizations XML with the language removed

removeLocalization

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

Removes the localization for the language from the localizations XML, optionally storing the localized strings as CDATA in the XML.

Parameters:

xml - the localizations XML

key - the name of the localized string, such as "Title"

requestedLanguageId - the ID of the language

cdata - whether to store localized strings as CDATA in the XML

Returns:

the localizations XML with the language removed

removeLocalization

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

Removes the localization for the language from the localizations XML, optionally storing the localized strings as CDATA in the XML.

Parameters:

xml - the localizations XML

key - the name of the localized string, such as "Title"

requestedLanguageId - the ID of the language

cdata - whether to store localized strings as CDATA in the XML

localized - whether there is a localized field

Returns:

the localizations XML with the language removed

setLocalizedPreferencesValues

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

Sets the localized preferences values for the parameter in the portlet request.

Parameters:

portletRequest - the portlet request

preferences - the preferences container

parameter - the prefix of the parameters containing the localized strings. Each localization is loaded from a parameter with this prefix, followed by an underscore, and the language ID.

Throws:

java.lang.Exception - if an exception occurred

setPreferencesValue

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

Sets the localized preferences value for the key in the language.

Parameters:

preferences - the preferences container

key - the preferences key

languageId - the ID of the language

value - the localized value

Throws:

java.lang.Exception - if an exception occurred

setPreferencesValues

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

Sets the localized preferences values for the key in the language.

Parameters:

preferences - the preferences container

key - the preferences key

languageId - the ID of the language

values - the localized values

Throws:

java.lang.Exception - if an exception occurred

updateLocalization

java.lang.String updateLocalization(java.util.Map<java.util.Locale,java.lang.String> localizationMap,
                                    java.lang.String xml,
                                    java.lang.String key,
                                    java.lang.String defaultLanguageId)

Updates the localized string for all the available languages in the localizations XML for the map of locales and localized strings and changes the default language. The localized strings are stored as characters in the XML.

Parameters:

localizationMap - the locales and localized strings

xml - the localizations XML

key - the name of the localized string, such as "Title"

defaultLanguageId - the ID of the default language

Returns:

the updated localizations XML

updateLocalization

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

Updates the localized string for the system default language in the localizations XML. The localized strings are stored as characters in the XML.

Parameters:

xml - the localizations XML

key - the name of the localized string, such as "Title"

value - the localized string

Returns:

the updated localizations XML

updateLocalization

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

Updates the localized string for the language in the localizations XML. The localized strings are stored as characters in the XML.

Parameters:

xml - the localizations XML

key - the name of the localized string, such as "Title"

value - the localized string

requestedLanguageId - the ID of the language

Returns:

the updated localizations XML

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)

Updates the localized string for the language in the localizations XML and changes the default language. The localized strings are stored as characters in the XML.

Parameters:

xml - the localizations XML

key - the name of the localized string, such as "Title"

value - the localized string

requestedLanguageId - the ID of the language

defaultLanguageId - the ID of the default language

Returns:

the updated localizations XML

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)

Updates the localized string for the language in the localizations XML and changes the default language, optionally storing the localized strings as CDATA in the XML.

Parameters:

xml - the localizations XML

key - the name of the localized string, such as "Title"

value - the localized string

requestedLanguageId - the ID of the language

defaultLanguageId - the ID of the default language

cdata - whether to store localized strings as CDATA in the XML

Returns:

the updated localizations XML

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,
                                    boolean localized)

Updates the localized string for the language in the localizations XML and changes the default language, optionally storing the localized strings as CDATA in the XML.

Parameters:

xml - the localizations XML

key - the name of the localized string, such as "Title"

value - the localized string

requestedLanguageId - the ID of the language

defaultLanguageId - the ID of the default language

cdata - whether to store localized strings as CDATA in the XML

localized - whether there is a localized field

Returns:

the updated localizations XML