com.redhat.rhn.common.localization

Class LocalizationService

java.lang.Object

com.redhat.rhn.common.localization.LocalizationService

public class LocalizationService
extends java.lang.Object

Localization service class to simplify the job for producing localized (translated) strings within the product.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Locale	DEFAULT_LOCALE
static java.lang.String	RHN_CUSTOM_DATEFORMAT
static java.lang.String	RHN_DB_DATEFORMAT DateFormat used by RHN database queries.

Method Summary

Modifier and Type	Method and Description
java.util.SortedMap<java.lang.String,java.lang.String>	availableCountries() Get a SortedMap containing NAME/CODE value pairs.
java.util.SortedSet<java.lang.String>	availablePrefixes() Get a list of available prefixes and ensure that it is sorted by returning a SortedSet object.
java.lang.String	formatCustomDate(java.util.Date date) Returns fixed custom format string displayed for the determined timezone Example: 2010-04-01 15:04:24 CEST
java.lang.String	formatDate(java.util.Date date) Format the date and let the service determine the locale
java.lang.String	formatDate(java.util.Date date, java.util.Locale locale) Format the date based on the locale and convert it to a String to display.
java.lang.String	formatNumber(java.lang.Number numberIn) Format the Number based on the locale and convert it to a String to display.
java.lang.String	formatNumber(java.lang.Number numberIn, int fractionalDigits) Format the Number based on the locale and convert it to a String to display.
java.lang.String	formatNumber(java.lang.Number numberIn, java.util.Locale localeIn) Format the Number based on the locale and convert it to a String to display.
java.lang.String	formatNumber(java.lang.Number numberIn, java.util.Locale localeIn, int fractionalDigits) Format the Number based on the locale and convert it to a String to display.
java.lang.String	formatShortDate(java.util.Date date) Format the date as a short date depending on locale (YYYY-MM-DD in the US)
java.lang.String	formatShortDate(java.util.Date date, java.util.Locale locale) Format the date as a short date depending on locale (YYYY-MM-DD in the US)
java.util.List<java.lang.String>	getAlphabet() Get alphabet list for callee's Thread's Locale
java.lang.String	getBasicDate() Use today's date and get it back localized and as a String
java.util.List<java.lang.String>	getConfiguredLocales() Returns the list of configured locales which is most likely a subset of all the supported locales
java.lang.String	getDebugMessage(java.lang.String messageId) Get localized text for log messages as well as error emails.
java.util.List<java.lang.String>	getDigits() Get digit list for callee's Thread's Locale
static LocalizationService	getInstance() Get the running instance of the LocalizationService
java.lang.String	getMessage(java.lang.String messageId) Get a localized version of a String and let the service attempt to figure out the callee's locale.
java.lang.String	getMessage(java.lang.String messageId, java.util.Locale locale) Get a localized version of a string with the specified locale.
java.lang.String	getMessage(java.lang.String messageId, java.util.Locale locale, java.lang.Object... args) Get a localized version of a string with the specified locale.
java.lang.String	getMessage(java.lang.String messageId, java.lang.Object... args) Get a localized version of a string with the specified locale.
java.lang.String[]	getMessages(java.lang.String[] keys) Take in a String array of keys and transform it into a String array of localized Strings.
java.lang.String	getPlainText(java.lang.String messageId) Gets a Plain Text + localized version of a string with the default locale.
java.lang.String	getPlainText(java.lang.String messageId, java.lang.Object... args) Gets a Plain Text + localized version of a string with the default locale.
java.util.List<java.lang.String>	getSupportedLocales() Get list of supported locales in string form
boolean	hasMessage(java.lang.String messageId) Simple util method to determine if the
protected void	initService() Initialize the set of strings and keys used by the service
boolean	isLocaleSupported(java.util.Locale locale) Determines if locale is supported
java.text.Collator	newCollator() Returns a NEW instance of the collator/string comparator based on the current locale..
boolean	reloadResourceFiles() Reload the resource files from the disk.

Methods inherited from class java.lang.Object

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

Field Detail

RHN_DB_DATEFORMAT

public static final java.lang.String RHN_DB_DATEFORMAT

DateFormat used by RHN database queries. Useful for converting RHN dates into java.util.Dates so they can be formatted based on Locale.

See Also:

Constant Field Values

RHN_CUSTOM_DATEFORMAT

public static final java.lang.String RHN_CUSTOM_DATEFORMAT

See Also:

Constant Field Values

DEFAULT_LOCALE

public static final java.util.Locale DEFAULT_LOCALE

Method Detail

initService

protected void initService()

Initialize the set of strings and keys used by the service

getInstance

public static LocalizationService getInstance()

Get the running instance of the LocalizationService

Returns:

The LocalizationService singleton

reloadResourceFiles

public boolean reloadResourceFiles()

Reload the resource files from the disk. Only works in development mode.

Returns:

boolean if we reloaded the files or not.

getMessage

public java.lang.String getMessage(java.lang.String messageId)

Get a localized version of a String and let the service attempt to figure out the callee's locale.

Parameters:

messageId - The key of the message we are fetching

Returns:

Translated String

getMessage

public java.lang.String getMessage(java.lang.String messageId,
                                   java.util.Locale locale)

Get a localized version of a string with the specified locale.

Parameters:

messageId - The key of the message we are fetching

locale - The locale to use when fetching the string

Returns:

Translated String

getMessage

public java.lang.String getMessage(java.lang.String messageId,
                                   java.lang.Object... args)

Get a localized version of a string with the specified locale.

Parameters:

messageId - The key of the message we are fetching

args - arguments for message.

Returns:

Translated String

getPlainText

public java.lang.String getPlainText(java.lang.String messageId,
                                     java.lang.Object... args)

Gets a Plain Text + localized version of a string with the default locale.

Parameters:

messageId - The key of the message we are fetching

args - arguments for message.

Returns:

Translated String

getPlainText

public java.lang.String getPlainText(java.lang.String messageId)

Gets a Plain Text + localized version of a string with the default locale.

Parameters:

messageId - The key of the message we are fetching

Returns:

Translated String

getMessages

public java.lang.String[] getMessages(java.lang.String[] keys)

Take in a String array of keys and transform it into a String array of localized Strings.

Parameters:

keys - String[] array of key values

Returns:

String[] array of localized strings.

getMessage

public java.lang.String getMessage(java.lang.String messageId,
                                   java.util.Locale locale,
                                   java.lang.Object... args)

Get a localized version of a string with the specified locale.

Parameters:

messageId - The key of the message we are fetching

locale - The locale to use when fetching the string

args - arguments for message.

Returns:

Translated String

getDebugMessage

public java.lang.String getDebugMessage(java.lang.String messageId)

Get localized text for log messages as well as error emails. Determines Locale of running JVM vs using the current Thread or any other User related Locale information. TODO mmccune Get Locale out of Config or from the JVM

Parameters:

messageId - The key of the message we are fetching

Returns:

String debug message.

formatDate

public java.lang.String formatDate(java.util.Date date)

Format the date and let the service determine the locale

Parameters:

date - Date to be formatted.

Returns:

String representation of given date.

formatShortDate

public java.lang.String formatShortDate(java.util.Date date)

Format the date as a short date depending on locale (YYYY-MM-DD in the US)

Parameters:

date - Date to be formatted

Returns:

String representation of given date.

formatShortDate

public java.lang.String formatShortDate(java.util.Date date,
                                        java.util.Locale locale)

Format the date as a short date depending on locale (YYYY-MM-DD in the US)

Parameters:

date - Date to be formatted

locale - Locale to use for formatting

Returns:

String representation of given date.

getBasicDate

public java.lang.String getBasicDate()

Use today's date and get it back localized and as a String

Returns:

String representation of today's date.

formatDate

public java.lang.String formatDate(java.util.Date date,
                                   java.util.Locale locale)

Format the date based on the locale and convert it to a String to display. Uses DateFormat.SHORT. Example: 2004-12-10 13:20:00 PST Also includes the timezone of the current User if there is one

Parameters:

date - Date to format.

locale - Locale to use for formatting.

Returns:

String representation of given date in given locale.

formatCustomDate

public java.lang.String formatCustomDate(java.util.Date date)

Returns fixed custom format string displayed for the determined timezone Example: 2010-04-01 15:04:24 CEST

Parameters:

date - Date to format.

Returns:

String representation of given date for set timezone

formatNumber

public java.lang.String formatNumber(java.lang.Number numberIn)

Format the Number based on the locale and convert it to a String to display.

Parameters:

numberIn - Number to format.

Returns:

String representation of given number in given locale.

formatNumber

public java.lang.String formatNumber(java.lang.Number numberIn,
                                     int fractionalDigits)

Format the Number based on the locale and convert it to a String to display. Use a specified number of fraction digits.

Parameters:

numberIn - Number to format.

fractionalDigits - The number of fractional digits to use. This is both the minimum and maximum that will be displayed.

Returns:

String representation of given number in given locale.

formatNumber

public java.lang.String formatNumber(java.lang.Number numberIn,
                                     java.util.Locale localeIn)

Format the Number based on the locale and convert it to a String to display.

Parameters:

numberIn - Number to format.

localeIn - Locale to use for formatting.

Returns:

String representation of given number in given locale.

formatNumber

public java.lang.String formatNumber(java.lang.Number numberIn,
                                     java.util.Locale localeIn,
                                     int fractionalDigits)

Format the Number based on the locale and convert it to a String to display. Use a specified number of fractional digits.

Parameters:

numberIn - Number to format.

localeIn - Locale to use for formatting.

fractionalDigits - The maximum number of fractional digits to use.

Returns:

String representation of given number in given locale.

getAlphabet

public java.util.List<java.lang.String> getAlphabet()

Get alphabet list for callee's Thread's Locale

Returns:

the list of alphanumeric characters from the alphabet

getDigits

public java.util.List<java.lang.String> getDigits()

Get digit list for callee's Thread's Locale

Returns:

the list of digits

availablePrefixes

public java.util.SortedSet<java.lang.String> availablePrefixes()

Get a list of available prefixes and ensure that it is sorted by returning a SortedSet object.

Returns:

SortedSet sorted set of available prefixes.

availableCountries

public java.util.SortedMap<java.lang.String,java.lang.String> availableCountries()

Get a SortedMap containing NAME/CODE value pairs. The reason we key the Map based on the NAME is that we desire to maintain a localized sort order based on the display value and not the code.

     {name=Spain,     code=ES}
     {name=Sri Lanka, code=LK}
     {name=Sudan,     code=SD}
     {name=Suriname,  code=SR, }
     etc ...
 

Returns:

SortedMap sorted map of available countries.

hasMessage

public boolean hasMessage(java.lang.String messageId)

Simple util method to determine if the

Parameters:

messageId - we are searching for

Returns:

boolean if we have loaded this message

getSupportedLocales

public java.util.List<java.lang.String> getSupportedLocales()

Get list of supported locales in string form

Returns:

supported locales

getConfiguredLocales

public java.util.List<java.lang.String> getConfiguredLocales()

Returns the list of configured locales which is most likely a subset of all the supported locales

Returns:

list of configured locales

isLocaleSupported

public boolean isLocaleSupported(java.util.Locale locale)

Determines if locale is supported

Parameters:

locale - user's locale

Returns:

result

newCollator

public java.text.Collator newCollator()

Returns a NEW instance of the collator/string comparator based on the current locale.. Look at the javadoc for COllator to see what it does... (basically an i18n aware string comparator)

Returns:

neww instance of the collator