org.deeplearning4j.ui.i18n

Class DefaultI18N

java.lang.Object

org.deeplearning4j.ui.i18n.DefaultI18N

All Implemented Interfaces:

I18N

public class DefaultI18N
extends Object
implements I18N

Default internationalization implementation.
Content for internationalization is implemented using resource files.
For the resource files: they should be specified as follows:
1. In the /dl4j_i18n/ directory in resources
2. Filenames should be "somekey.langcode" - for example, "index.en" or "index.ja"
3. Each key should be unique across all files. Any key can appear in any file; files may be split for convenience

Loading of these UI resources is done as follows:
- On initialization of the DefaultI18N:
- Resource files for the default language are loaded
- If a different language is requested, the content will be loaded on demand (and stored in memory for future use)
Note that if a specified language does not have the specified key, the result from the defaultfallback language (English) will be used instead.

Author:

Alex Black

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LANGUAGE
static String	FALLBACK_LANGUAGE

Method Summary

Modifier and Type	Method and Description
String	getDefaultLanguage() Get the currently set default language as an ISO 639-1 code
static I18N	getInstance() Get global instance (used in single-session mode)
static I18N	getInstance(String sessionId) Get instance for session (used in multi-session mode)
String	getMessage(String key) Get the specified message in the default language (according to I18N.getDefaultLanguage()
String	getMessage(String langCode, String key) Get the specified message for the specified language
Map<String,String>	getMessages(String langCode) Get all internationalization messages for the specified language code
static I18N	removeInstance(String sessionId) Remove I18N instance for session
void	setDefaultLanguage(String langCode) Set the default language

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LANGUAGE

public static final String DEFAULT_LANGUAGE

See Also:

Constant Field Values

FALLBACK_LANGUAGE

public static final String FALLBACK_LANGUAGE

See Also:

Constant Field Values

Method Detail

getInstance

public static I18N getInstance()

Get global instance (used in single-session mode)

Returns:

global instance

getInstance

public static I18N getInstance(String sessionId)

Get instance for session (used in multi-session mode)

Parameters:

sessionId - session

Returns:

instance for session

removeInstance

public static I18N removeInstance(String sessionId)

Remove I18N instance for session

Parameters:

sessionId - session ID

Returns:

the previous value associated with sessionId, or null if there was no mapping for sessionId

getMessage

public String getMessage(String key)

Description copied from interface: I18N

Get the specified message in the default language (according to I18N.getDefaultLanguage()

Specified by:

getMessage in interface I18N

Parameters:

key - Key value

Returns:

Message for the given key, or null if none is found/available

getMessage

public String getMessage(String langCode,
                         String key)

Description copied from interface: I18N

Get the specified message for the specified language

Specified by:

getMessage in interface I18N

Parameters:

langCode - ISO 639-1 language code: "en", "ja", etc

key - Key value for the message to retrieve

Returns:

Message for the given key/language pair, or null if none is found

getDefaultLanguage

public String getDefaultLanguage()

Description copied from interface: I18N

Get the currently set default language as an ISO 639-1 code

Specified by:

getDefaultLanguage in interface I18N

Returns:

The current default language

setDefaultLanguage

public void setDefaultLanguage(String langCode)

Description copied from interface: I18N

Set the default language

Specified by:

setDefaultLanguage in interface I18N

Parameters:

langCode - Language code, as an ISO 639-1 code

getMessages

public Map<String,String> getMessages(String langCode)

Description copied from interface: I18N

Get all internationalization messages for the specified language code

Specified by:

getMessages in interface I18N

Parameters:

langCode - Language code

Returns:

Messages