Package com.inductiveautomation.ignition.common.i18n.translation

Class DelegateTranslationPackage

java.lang.Object

com.inductiveautomation.ignition.common.i18n.translation.DelegateTranslationPackage

All Implemented Interfaces:

MutableTranslationPackage, TranslationPackage

public class DelegateTranslationPackage
extends Object
implements MutableTranslationPackage

Constructor Summary

Constructors

Constructor	Description
DelegateTranslationPackage()

Method Summary

Modifier and Type	Method	Description
void	addTerm(String key)	Ensures that the specified key is in the translation package.
void	addTranslation(String key, Locale locale, String value)	Sets a translation for the specified key and locale.
void	addTranslations(String key, TranslationMap translations)	Sets all of the translations for a specific key.
TranslationPackageDiff	createDiff()	Creates an empty, modifiable diff that respects the same rules as this translation package.
void	ensureLocaleExists(Locale locale)	Verifies that the locale is present, adding it if necessary.
String	get(Locale locale, String key)	Translates the given key into the requested locale.
Iterator<Translation>	getAllTranslations()
Collection<String>	getAvailableKeys()
Collection<Locale>	getAvailableLocales()
Locale	getBaseLocale()
KeyHashRule	getKeyHashRule()	The key hash rule dictates how term equivalency is calculated.
String	getStrict(Locale locale, String key)	Translates the given key into the requested locale, returning null if no translation exists.
TranslationMap	getTranslationsFor(String key)
boolean	isDefined(String key)	Returns whether the key is defined in the package.
boolean	isDefined(String key, Locale l)	Returns whether there is a translation defined for the given key in the given locale.
boolean	removeKey(String key)	Removes the specific key, and any translations.
void	removeLocale(Locale locale)
void	removeTranslation(String key, Locale locale)	Removes a translation for a specified key and locale.
void	setDelegatePackage(MutableTranslationPackage value)

Methods inherited from class java.lang.Object

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

Constructor Details

DelegateTranslationPackage

public DelegateTranslationPackage()

Method Details

setDelegatePackage

public void setDelegatePackage(MutableTranslationPackage value)

getKeyHashRule

public KeyHashRule getKeyHashRule()

Description copied from interface: TranslationPackage

The key hash rule dictates how term equivalency is calculated. Though this field should not be used to look up terms, it's important that derived translation packages use the same rule.

Specified by:

getKeyHashRule in interface TranslationPackage

addTerm

public void addTerm(String key)

Description copied from interface: MutableTranslationPackage

Ensures that the specified key is in the translation package. This registers a key without necessarily providing a translation immediately.

Specified by:

addTerm in interface MutableTranslationPackage

Parameters:

key - The key to add.

addTranslation

public void addTranslation(String key,
 Locale locale,
 String value)

Description copied from interface: MutableTranslationPackage

Sets a translation for the specified key and locale.

Specified by:

addTranslation in interface MutableTranslationPackage

Parameters:

key - The key to translate.

locale - The target locale.

value - The translated string.

removeTranslation

public void removeTranslation(String key,
 Locale locale)

Description copied from interface: MutableTranslationPackage

Removes a translation for a specified key and locale. Used when someone had a translation and blanks it out. This removes the specific translation but keeps the key in the package.

Specified by:

removeTranslation in interface MutableTranslationPackage

Parameters:

key - The key to modify.

locale - The locale for which to remove the translation.

getBaseLocale

public Locale getBaseLocale()

Specified by:

getBaseLocale in interface TranslationPackage

Returns:

the "base" locale, the language in which the terms are defined.

addTranslations

public void addTranslations(String key,
 TranslationMap translations)

Description copied from interface: MutableTranslationPackage

Sets all of the translations for a specific key. Translation map can be null, in which case the key will simply be registered in the index.

Specified by:

addTranslations in interface MutableTranslationPackage

getAvailableLocales

public Collection<Locale> getAvailableLocales()

Specified by:

getAvailableLocales in interface TranslationPackage

Returns:

the locales for which translations are available. This will include the base locale.

isDefined

public boolean isDefined(String key)

Description copied from interface: TranslationPackage

Returns whether the key is defined in the package. A key can be defined without any particular translations.

Specified by:

isDefined in interface TranslationPackage

removeKey

public boolean removeKey(String key)

Description copied from interface: MutableTranslationPackage

Removes the specific key, and any translations.

Specified by:

removeKey in interface MutableTranslationPackage

Returns:

true if key was present

isDefined

public boolean isDefined(String key,
 Locale l)

Description copied from interface: TranslationPackage

Returns whether there is a translation defined for the given key in the given locale.

Specified by:

isDefined in interface TranslationPackage

ensureLocaleExists

public void ensureLocaleExists(Locale locale)

Description copied from interface: MutableTranslationPackage

Verifies that the locale is present, adding it if necessary.

Specified by:

ensureLocaleExists in interface MutableTranslationPackage

removeLocale

public void removeLocale(Locale locale)

Specified by:

removeLocale in interface MutableTranslationPackage

get

public String get(Locale locale,
 String key)

Description copied from interface: TranslationPackage

Translates the given key into the requested locale.

Specified by:

get in interface TranslationPackage

Parameters:

locale - the locale to find a match for

key - the key to find a match for

Returns:

the translation of the key for the requested locale, or the key itself if no translation is available.

getStrict

public String getStrict(Locale locale,
 String key)

Description copied from interface: TranslationPackage

Translates the given key into the requested locale, returning null if no translation exists.

Specified by:

getStrict in interface TranslationPackage

Parameters:

locale - the locale to find a value for

key - the key to find a match for

Returns:

the translation, or null if the translation doesn't exist.

getTranslationsFor

public TranslationMap getTranslationsFor(String key)

Specified by:

getTranslationsFor in interface TranslationPackage

Returns:

a map of all of the translations available for a given key.

getAvailableKeys

public Collection<String> getAvailableKeys()

Specified by:

getAvailableKeys in interface TranslationPackage

Returns:

all of the defined keys.

createDiff

public TranslationPackageDiff createDiff()

Description copied from interface: TranslationPackage

Creates an empty, modifiable diff that respects the same rules as this translation package. A diff is used to track changes relative to this package.

Specified by:

createDiff in interface TranslationPackage

Returns:

a new TranslationPackageDiff.

getAllTranslations

public Iterator<Translation> getAllTranslations()

Specified by:

getAllTranslations in interface TranslationPackage

Returns:

an iterator that goes through all of the translations. Does not include defined keys that have no translations.