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

Class BasicTranslationPackage

java.lang.Object

com.inductiveautomation.ignition.common.i18n.translation.BasicTranslationPackage

All Implemented Interfaces:

MutableTranslationPackage, TranslationPackage

Direct Known Subclasses:

TranslationPackageDiff

public class BasicTranslationPackage
extends Object
implements MutableTranslationPackage

A translation package implementation that manages an index of terms and multiple TranslationBundle objects for different locales.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicTranslationPackage.JsonAdapter

Field Summary

Fields

Modifier and Type	Field	Description
protected Locale	baseLocale
protected final Map<Locale,TranslationBundle>	bundles
protected KeyHashRule	hashRule
protected Map<String,TermKey>	index

Constructor Summary

Constructors

Constructor	Description
BasicTranslationPackage()
BasicTranslationPackage(TranslationPackage copy)
BasicTranslationPackage(Locale baseLocale, KeyHashRule hashRule)

Method Summary

Modifier and Type	Method	Description
void	addTerm(String key)	Ensures that the specified key is in the translation package.
void	addTranslation(String term, Locale targetLocale, String translation)	Sets a translation for the specified key and locale.
void	addTranslations(String key, TranslationMap translations)	Sets all of the translations for a specific key.
void	applyPackage(TranslationPackage tp)	Merges another package's translations into this one.
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.
boolean	equals(Object obj)
String	get(Locale locale, String key)	Returns the translation of the key for the requested locale, or the key, if the translation is not available.
Iterator<Translation>	getAllTranslations()
Collection<String>	getAvailableKeys()
Collection<Locale>	getAvailableLocales()
Locale	getBaseLocale()
TranslationBundle	getBundle(Locale l)
Map<String,TermKey>	getIndex()
KeyHashRule	getKeyHashRule()	The key hash rule dictates how term equivalency is calculated.
TranslationBundle	getOrCreateBundle(Locale l)
protected TermKey	getOrCreateTermKey(String term)
protected String	getOrNull(List<Locale> locales, String key)	Returns the translation, or null.
String	getStrict(Locale locale, String key)	Translates the given key into the requested locale, returning null if no translation exists.
protected TermKey	getTermKey(String term)
TranslationMap	getTranslationsFor(String key)
protected String	hashKey(String term)	Returns the hashKey for the term *
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 term, Locale locale)	Removes a translation for a specified key and locale.
void	setBaseLocale(Locale baseLocale)
void	setIndex(Map<String,TermKey> index)
void	setKeyHashRule(KeyHashRule rule)
void	updateIndex(Collection<String> keys)

Methods inherited from class java.lang.Object

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

Field Details

index

protected Map<String,TermKey> index

hashRule

protected KeyHashRule hashRule

baseLocale

protected Locale baseLocale

bundles

protected final Map<Locale,TranslationBundle> bundles

Constructor Details

BasicTranslationPackage

public BasicTranslationPackage(TranslationPackage copy)

BasicTranslationPackage

public BasicTranslationPackage()

BasicTranslationPackage

public BasicTranslationPackage(Locale baseLocale,
 KeyHashRule hashRule)

Method Details

hashKey

protected String hashKey(String term)

Returns the hashKey for the term *

getTermKey

protected TermKey getTermKey(String term)

getOrCreateTermKey

protected TermKey getOrCreateTermKey(String term)

getIndex

public Map<String,TermKey> getIndex()

setIndex

public void setIndex(Map<String,TermKey> index)

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

setKeyHashRule

public void setKeyHashRule(KeyHashRule rule)

getBaseLocale

public Locale getBaseLocale()

Specified by:

getBaseLocale in interface TranslationPackage

Returns:

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

setBaseLocale

public void setBaseLocale(Locale baseLocale)

getAvailableKeys

public Collection<String> getAvailableKeys()

Specified by:

getAvailableKeys in interface TranslationPackage

Returns:

all of the defined keys.

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.

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

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

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

get

public String get(Locale locale,
 String key)

Returns the translation of the key for the requested locale, or the key, if the translation is not available.

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.

getOrNull

protected String getOrNull(List<Locale> locales,
 String key)

Returns the translation, or null. This is true even for the base locale, in which case we would be trying to look up the "alternate".

getBundle

public TranslationBundle getBundle(Locale l)

getOrCreateBundle

public TranslationBundle getOrCreateBundle(Locale l)

updateIndex

public void updateIndex(Collection<String> 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.

applyPackage

public void applyPackage(TranslationPackage tp)

Merges another package's translations into this one. If the provided package is a TranslationPackageDiff, it will also process any removals.

Parameters:

tp - The package to apply.

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.

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.

addTranslation

public void addTranslation(String term,
 Locale targetLocale,
 String translation)

Description copied from interface: MutableTranslationPackage

Sets a translation for the specified key and locale.

Specified by:

addTranslation in interface MutableTranslationPackage

Parameters:

term - The key to translate.

targetLocale - The target locale.

translation - The translated string.

removeTranslation

public void removeTranslation(String term,
 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:

term - The key to modify.

locale - The locale for which to remove the translation.

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.

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

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

removeLocale

public void removeLocale(Locale locale)

Specified by:

removeLocale in interface MutableTranslationPackage

equals

public boolean equals(Object obj)

Overrides:

equals in class Object