org.dspace.core

Class I18nUtil

java.lang.Object

org.dspace.core.I18nUtil

public class I18nUtil
extends java.lang.Object

I18nUtil.java Some Utilities for i18n Support. - getting the default Locale for this DSpace Instance - getting all supported Locales for this DSpace Instance - getting email template, help file, input forms for a given Locale

Version:

1.0

Author:

Bernadette Schlonsok and Claudia Juergen

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Locale	DEFAULTLOCALE

Constructor Summary

Constructors

Constructor and Description
I18nUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getDefaultLicense(Context context) Get the appropriate localized version of the default.license according to language settings
static java.util.Locale	getDefaultLocale() Gets the default locale as defined in dspace.cfg If no default locale is defined, the Locale of the JVM is used
static java.lang.String	getEmailFilename(java.util.Locale locale, java.lang.String name) Get the appropriate localized version of an email template according to language settings
static java.util.Locale	getEPersonLocale(EPerson ep) Get the Locale for a specified EPerson.
static java.lang.String	getInputFormsFileName(java.util.Locale locale) Get the appropriate localized version of input-forms.xml according to language settings
static java.lang.String	getMessage(java.lang.String key) et the i18n message string for a given key and use the default Locale
static java.lang.String	getMessage(java.lang.String key, Context c) Get the i18n message string for a given key and context
static java.lang.String	getMessage(java.lang.String key, java.util.Locale locale) Get the i18n message string for a given key and locale
static java.util.Locale	getSupportedLocale(java.util.Locale locale) Gets the appropriate supported Locale according for a given Locale If no appropriate supported locale is found, the DEFAULTLOCALE is used
static java.util.Locale[]	getSupportedLocales() get the available Locales for the User Interface as defined in dspace.cfg returns an array of Locales or null
static java.util.Locale[]	parseLocales(java.lang.String ll) Creates array of Locales from text list of locale-specifications.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULTLOCALE

public static final java.util.Locale DEFAULTLOCALE

Constructor Detail

I18nUtil

public I18nUtil()

Method Detail

getDefaultLocale

public static java.util.Locale getDefaultLocale()

Gets the default locale as defined in dspace.cfg If no default locale is defined, the Locale of the JVM is used

Returns:

defaultLocale the default Locale for this DSpace instance

getEPersonLocale

public static java.util.Locale getEPersonLocale(EPerson ep)

Get the Locale for a specified EPerson. If the language is missing, return the default Locale for the repository.

Parameters:

ep -

getSupportedLocales

public static java.util.Locale[] getSupportedLocales()

get the available Locales for the User Interface as defined in dspace.cfg returns an array of Locales or null

Returns:

an array of supported Locales or null

getSupportedLocale

public static java.util.Locale getSupportedLocale(java.util.Locale locale)

Gets the appropriate supported Locale according for a given Locale If no appropriate supported locale is found, the DEFAULTLOCALE is used

Parameters:

locale - Locale to find the corresponding Locale

Returns:

supportedLocale Locale for session according to locales supported by this DSpace instance as set in dspace.cfg

getInputFormsFileName

public static java.lang.String getInputFormsFileName(java.util.Locale locale)

Get the appropriate localized version of input-forms.xml according to language settings

Parameters:

locale - Locale, the local to get the input-forms.xml for

Returns:

String - localized filename for input-forms.xml

getMessage

public static java.lang.String getMessage(java.lang.String key)
                                   throws java.util.MissingResourceException

et the i18n message string for a given key and use the default Locale

Parameters:

key - String - name of the key to get the message for

Returns:

message String of the message

Throws:

java.util.MissingResourceException

getMessage

public static java.lang.String getMessage(java.lang.String key,
                          java.util.Locale locale)
                                   throws java.util.MissingResourceException

Get the i18n message string for a given key and locale

Parameters:

key - String - name of the key to get the message for

locale - Locale, to get the message for

Returns:

message String of the message

Throws:

java.util.MissingResourceException

getMessage

public static java.lang.String getMessage(java.lang.String key,
                          Context c)
                                   throws java.util.MissingResourceException

Get the i18n message string for a given key and context

Parameters:

key - String - name of the key to get the message for

c - Context having the desired Locale

Returns:

message String of the message

Throws:

java.util.MissingResourceException

getDefaultLicense

public static java.lang.String getDefaultLicense(Context context)

Get the appropriate localized version of the default.license according to language settings

Parameters:

context - the current DSpace context

Returns:

fileName String - localized filename for default.license

getEmailFilename

public static java.lang.String getEmailFilename(java.util.Locale locale,
                                java.lang.String name)

Get the appropriate localized version of an email template according to language settings

Parameters:

locale - Locale for this request

name - String - base name of the email template

Returns:

templateName String - localized filename of an email template

parseLocales

public static java.util.Locale[] parseLocales(java.lang.String ll)

Creates array of Locales from text list of locale-specifications. Used to parse lists in DSpace configuration properties.

Parameters:

ll - locale list of comma-separated values

Returns:

array of locale results, possibly empty