|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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.
| Method Summary | |
|---|---|
Object |
deserialize(JSONObject jsonObject)
Deserializes the JSON object into a map of locales and localized strings. |
String[] |
getAvailableLanguageIds(Document document)
|
String[] |
getAvailableLanguageIds(String xml)
Returns the available locales from the localizations XML. |
Locale |
getDefaultImportLocale(String className,
long classPK,
Locale contentDefaultLocale,
Locale[] contentAvailableLocales)
Returns a valid default locale for importing a localized entity. |
String |
getDefaultLanguageId(Document document)
|
String |
getDefaultLanguageId(Document document,
Locale defaultLocale)
|
String |
getDefaultLanguageId(String xml)
Returns the default locale from the localizations XML. |
String |
getDefaultLanguageId(String xml,
Locale defaultLocale)
|
String |
getLocalization(String xml,
String requestedLanguageId)
Returns the localized string from the localizations XML in the language. |
String |
getLocalization(String xml,
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. |
String |
getLocalization(String xml,
String requestedLanguageId,
boolean useDefault,
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. |
Map<Locale,String> |
getLocalizationMap(Collection<Locale> locales,
Locale defaultLocale,
String key)
Returns a map of locales and localized strings for the key. |
Map<Locale,String> |
getLocalizationMap(javax.servlet.http.HttpServletRequest request,
String parameter)
Returns a map of locales and localized strings for the parameter in the request. |
Map<Locale,String> |
getLocalizationMap(PortletPreferences preferences,
String preferenceName)
Returns a map of locales and localized strings for the preference in the preferences container. |
Map<Locale,String> |
getLocalizationMap(PortletPreferences preferences,
String preferenceName,
String propertyName)
Returns a map of locales and localized strings for the preference in the preferences container. |
Map<Locale,String> |
getLocalizationMap(PortletPreferences preferences,
String preferenceName,
String propertyName,
String defaultPropertyValue,
ClassLoader classLoader)
|
Map<Locale,String> |
getLocalizationMap(PortletRequest portletRequest,
String parameter)
Returns a map of locales and localized strings for the parameter in the portlet request. |
Map<Locale,String> |
getLocalizationMap(PortletRequest portletRequest,
String parameter,
Map<Locale,String> defaultValues)
|
Map<Locale,String> |
getLocalizationMap(String xml)
Returns a map of locales and localized strings from the localizations XML. |
Map<Locale,String> |
getLocalizationMap(String[] languageIds,
String[] values)
Returns a map of locales and localized strings for the given languageIds and values. |
Map<Locale,String> |
getLocalizationMap(String xml,
boolean useDefault)
|
Map<Locale,String> |
getLocalizationMap(String bundleName,
ClassLoader classLoader,
String key,
boolean includeBetaLocales)
|
String |
getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
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. |
String |
getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
String parameter,
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. |
String |
getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
String parameter,
String prefix,
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. |
String |
getLocalizedName(String name,
String languageId)
Returns the localized name in the language. |
Map<Locale,String> |
getLocalizedParameter(PortletRequest portletRequest,
String parameter)
Deprecated. As of 6.2.0, replaced by getLocalizationMap(PortletRequest, String) |
Map<Locale,String> |
getMap(LocalizedValuesMap localizedValuesMap)
|
String |
getPreferencesKey(String key,
String languageId)
Deprecated. As of 7.0.0, replaced by getLocalizedName(String,
String) |
String |
getPreferencesValue(PortletPreferences preferences,
String key,
String languageId)
Returns the localized preferences value for the key in the language. |
String |
getPreferencesValue(PortletPreferences preferences,
String key,
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. |
String[] |
getPreferencesValues(PortletPreferences preferences,
String key,
String languageId)
Returns the localized preferences values for the key in the language. |
String[] |
getPreferencesValues(PortletPreferences preferences,
String key,
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. |
String |
getSettingsValue(Settings settings,
String key,
String languageId)
Returns the localized settings value for the key in the language. |
String |
getSettingsValue(Settings settings,
String key,
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. |
String[] |
getSettingsValues(Settings settings,
String key,
String languageId)
Returns the localized settings values for the key in the language. |
String[] |
getSettingsValues(Settings settings,
String key,
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. |
String |
getXml(LocalizedValuesMap localizedValuesMap,
String key)
|
String |
removeLocalization(String xml,
String key,
String requestedLanguageId)
Removes the localization for the language from the localizations XML. |
String |
removeLocalization(String xml,
String key,
String requestedLanguageId,
boolean cdata)
Removes the localization for the language from the localizations XML, optionally storing the localized strings as CDATA in the XML. |
String |
removeLocalization(String xml,
String key,
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(PortletRequest portletRequest,
PortletPreferences preferences,
String parameter)
Sets the localized preferences values for the parameter in the portlet request. |
void |
setPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
String value)
Sets the localized preferences value for the key in the language. |
void |
setPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
String[] values)
Sets the localized preferences values for the key in the language. |
String |
updateLocalization(Map<Locale,String> localizationMap,
String xml,
String key,
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. |
String |
updateLocalization(String xml,
String key,
String value)
Updates the localized string for the system default language in the localizations XML. |
String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId)
Updates the localized string for the language in the localizations XML. |
String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId)
Updates the localized string for the language in the localizations XML and changes the default language. |
String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
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. |
String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
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 |
|---|
Object deserialize(JSONObject jsonObject)
jsonObject - the JSON object
String[] getAvailableLanguageIds(Document document)
String[] getAvailableLanguageIds(String xml)
xml - the localizations XML
Locale getDefaultImportLocale(String className,
long classPK,
Locale contentDefaultLocale,
Locale[] contentAvailableLocales)
className - the class name of the entityclassPK - the primary keys of the entitycontentDefaultLocale - the default Locale of the entitycontentAvailableLocales - the available locales of the entity
String getDefaultLanguageId(Document document)
String getDefaultLanguageId(Document document,
Locale defaultLocale)
String getDefaultLanguageId(String xml)
xml - the localizations XML
String getDefaultLanguageId(String xml,
Locale defaultLocale)
String getLocalization(String xml,
String requestedLanguageId)
xml - the localizations XMLrequestedLanguageId - the ID of the language
String getLocalization(String xml,
String requestedLanguageId,
boolean useDefault)
xml - the localizations XMLrequestedLanguageId - the ID of the languageuseDefault - whether to use the default language if no localization
exists for the requested language
useDefault is false and no localization
exists for the requested language
String getLocalization(String xml,
String requestedLanguageId,
boolean useDefault,
String defaultValue)
xml - the localizations XMLrequestedLanguageId - the ID of the languageuseDefault - whether to use the default language if no localization
exists for the requested languagedefaultValue - the value returned if no localization exists
defaultValue if
useDefault is false and no localization
exists for the requested language
Map<Locale,String> getLocalizationMap(Collection<Locale> locales,
Locale defaultLocale,
String key)
locales - the locales to be used in the mapdefaultLocale - the default localekey - the language key to be translated
Map<Locale,String> getLocalizationMap(javax.servlet.http.HttpServletRequest request,
String parameter)
request - the requestparameter - 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.
Map<Locale,String> getLocalizationMap(PortletPreferences preferences,
String preferenceName)
preferences - the preferences containerpreferenceName - 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.
Map<Locale,String> getLocalizationMap(PortletPreferences preferences,
String preferenceName,
String propertyName)
preferences - the preferences containerpreferenceName - 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
Map<Locale,String> getLocalizationMap(PortletPreferences preferences,
String preferenceName,
String propertyName,
String defaultPropertyValue,
ClassLoader classLoader)
Map<Locale,String> getLocalizationMap(PortletRequest portletRequest,
String parameter)
portletRequest - the portlet requestparameter - 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.
Map<Locale,String> getLocalizationMap(PortletRequest portletRequest,
String parameter,
Map<Locale,String> defaultValues)
Map<Locale,String> getLocalizationMap(String xml)
xml - the localizations XML
Map<Locale,String> getLocalizationMap(String xml,
boolean useDefault)
Map<Locale,String> getLocalizationMap(String bundleName,
ClassLoader classLoader,
String key,
boolean includeBetaLocales)
Map<Locale,String> getLocalizationMap(String[] languageIds,
String[] values)
languageIds - the languageIds of the localized Stringsvalues - the localized strings for the different languageId
String getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
String parameter)
preferences - the preferences containerportletRequest - the portlet requestparameter - 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.
String getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
String parameter,
String defaultValue)
preferences - the preferences containerportletRequest - the portlet requestparameter - 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
String getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
String parameter,
String prefix,
String defaultValue)
preferences - the preferences containerportletRequest - the portlet requestparameter - 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 namedefaultValue - the value used as the localization for the default
locale, if no localization exists for it
defaultValue if no localization exists
String getLocalizedName(String name,
String languageId)
name - the name to be localizedlanguageId - the ID of the language
@Deprecated
Map<Locale,String> getLocalizedParameter(PortletRequest portletRequest,
String parameter)
getLocalizationMap(PortletRequest, String)
Map<Locale,String> getMap(LocalizedValuesMap localizedValuesMap)
@Deprecated
String getPreferencesKey(String key,
String languageId)
getLocalizedName(String,
String)
key - the preferences keylanguageId - the ID of the language
String getPreferencesValue(PortletPreferences preferences,
String key,
String languageId)
preferences - the preferences containerkey - the preferences keylanguageId - the ID of the language
String getPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
boolean useDefault)
preferences - the preferences containerkey - the preferences keylanguageId - the ID of the languageuseDefault - whether to use the default language if no localization
exists for the requested language
useDefault is false and no localization
exists for the requested language
String[] getPreferencesValues(PortletPreferences preferences,
String key,
String languageId)
preferences - the preferences containerkey - the preferences keylanguageId - the ID of the language
String[] getPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
boolean useDefault)
preferences - the preferences containerkey - the preferences keylanguageId - the ID of the languageuseDefault - whether to use the default language if no localization
exists for the requested language
useDefault is false and no localization
exists for the requested language
String getSettingsValue(Settings settings,
String key,
String languageId)
settings - the settingskey - the settings keylanguageId - the ID of the language
String getSettingsValue(Settings settings,
String key,
String languageId,
boolean useDefault)
settings - the settingskey - the settings keylanguageId - the ID of the languageuseDefault - whether to use the default language if no localization
exists for the requested language
useDefault is
false and no localization exists for the requested
language, an empty string is returned.
String[] getSettingsValues(Settings settings,
String key,
String languageId)
settings - the settingskey - the settings keylanguageId - the ID of the language
String[] getSettingsValues(Settings settings,
String key,
String languageId,
boolean useDefault)
settings - the settingskey - the settings keylanguageId - the ID of the languageuseDefault - whether to use the default language if no localization
exists for the requested language
useDefault is
false and no localization exists for the requested
language, an empty array is returned.
String getXml(LocalizedValuesMap localizedValuesMap,
String key)
String removeLocalization(String xml,
String key,
String requestedLanguageId)
xml - the localizations XMLkey - the name of the localized string, such as "Title"requestedLanguageId - the ID of the language
String removeLocalization(String xml,
String key,
String requestedLanguageId,
boolean cdata)
xml - the localizations XMLkey - the name of the localized string, such as "Title"requestedLanguageId - the ID of the languagecdata - whether to store localized strings as CDATA in the XML
String removeLocalization(String xml,
String key,
String requestedLanguageId,
boolean cdata,
boolean localized)
xml - the localizations XMLkey - the name of the localized string, such as "Title"requestedLanguageId - the ID of the languagecdata - whether to store localized strings as CDATA in the XMLlocalized - whether there is a localized field
void setLocalizedPreferencesValues(PortletRequest portletRequest,
PortletPreferences preferences,
String parameter)
throws Exception
portletRequest - the portlet requestpreferences - the preferences containerparameter - 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.
Exception - if an exception occurred
void setPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
String value)
throws Exception
preferences - the preferences containerkey - the preferences keylanguageId - the ID of the languagevalue - the localized value
Exception - if an exception occurred
void setPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
String[] values)
throws Exception
preferences - the preferences containerkey - the preferences keylanguageId - the ID of the languagevalues - the localized values
Exception - if an exception occurred
String updateLocalization(Map<Locale,String> localizationMap,
String xml,
String key,
String defaultLanguageId)
localizationMap - the locales and localized stringsxml - the localizations XMLkey - the name of the localized string, such as "Title"defaultLanguageId - the ID of the default language
String updateLocalization(String xml,
String key,
String value)
xml - the localizations XMLkey - the name of the localized string, such as "Title"value - the localized string
String updateLocalization(String xml,
String key,
String value,
String requestedLanguageId)
xml - the localizations XMLkey - the name of the localized string, such as "Title"value - the localized stringrequestedLanguageId - the ID of the language
String updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId)
xml - the localizations XMLkey - the name of the localized string, such as "Title"value - the localized stringrequestedLanguageId - the ID of the languagedefaultLanguageId - the ID of the default language
String updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId,
boolean cdata)
xml - the localizations XMLkey - the name of the localized string, such as "Title"value - the localized stringrequestedLanguageId - the ID of the languagedefaultLanguageId - the ID of the default languagecdata - whether to store localized strings as CDATA in the XML
String updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId,
boolean cdata,
boolean localized)
xml - the localizations XMLkey - the name of the localized string, such as "Title"value - the localized stringrequestedLanguageId - the ID of the languagedefaultLanguageId - the ID of the default languagecdata - whether to store localized strings as CDATA in the XMLlocalized - whether there is a localized field
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||