org.xmlactions.action.config

Class LanguageLocale

java.lang.Object

org.xmlactions.action.config.LanguageLocale

public class LanguageLocale
extends java.lang.Object

This class manages the language locale.

Using an entry on the page such as ${lang:key} you can retrieve the language value for that key.

The replacement pattern is "lang:key:resouce:language:country:variant"
where:

• "lang" - states that we want a locale language replacement. This is a required field.
• "key" - is the reference to the property key that we want the replacement value for. This is a required field.
• "resource" - is the name of the resource file to use. This is an optional field and if not set the default language file will be used.
• "language" - is the language to use. Example: "en" (English), "ja" (Japanese), "kok" (Konkani). This is an optional field and if not set the default locale language is used.
• "country" - is the country to use. Example: "US" (United States), "FR" (France), "029" (Caribbean). This is an optional field and if not set the default locale language is used.
• "variant" - is the language variant we want to use. Example: "polyton" (Polytonic Greek), "POSIX". This is an optional field and if not set the default locale language is used.

Example:
${lang:application.title} - Will use the default language properties file and get the value for application.title
${lang:application.title:jms_services} - Will use the language properties file jms_services and get the value for application.title

A default language file is setup for the key default_locale_file. Usually this is configured in the web.properties file loaded by the spring configuration.

Constructor Summary

Constructors

Constructor and Description
LanguageLocale()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getLang(IExecContext execContext, java.lang.String replacementPattern) Get a value for key from a language (locale) file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LanguageLocale

public LanguageLocale()

Method Detail

getLang

public java.lang.Object getLang(IExecContext execContext,
                                java.lang.String replacementPattern)

Get a value for key from a language (locale) file.

The replacementPattern format is "lang:key:resouce:language:country:variant"
or "lang:key" uses the default resource file and the default locale
or "lang:key:resource" uses the resource file and the default locale
or "lang:key::language" uses the default resource file and the language locale

Parameters:

replacementPattern - - the replacement pattern that was entered within the StrSubstitution

Returns:

the value for key or null if not found.