sirius.kernel.nls

Class Translation

java.lang.Object

sirius.kernel.nls.Translation

public class Translation
extends Object

Describes a translated property.

Used by Babelfish to manage all translations available.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Translation(String key) Creates a new translation, containing all native language values for the given key.

Method Summary

Modifier and Type	Method and Description
void	addTranslation(String lang, String value, boolean silent) Adds a translation for the given language.
protected boolean	containsText(String effectiveFilter) Checks if the given filter is either contained in the key or in one of the translations
String	getFile() Returns the name of the file in which the property is defined.
String	getKey() Returns the key for which the translation can be found
boolean	hasTranslation(String lang) Determines if a translation for the given language is available
boolean	isAccessed() Determines whether the translation was already accessed
boolean	isAutocreated() Returns true if the translation was auto created as it was missing in the .properties files.
protected void	setAutocreated(boolean autocreated) Sets the the autocreated flag.
protected void	setFile(String file) Sets the name of the file in which the property is defined.
String	translate(String lang) Returns the translation for the given language
String	translateWithoutFallback(String lang) Returns the translation for the given language
protected void	writeTo(Map<String,sirius.kernel.nls.SortedProperties> propMap) Writes all translations into the given map

Methods inherited from class java.lang.Object

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

Constructor Detail

Translation

protected Translation(String key)

Creates a new translation, containing all native language values for the given key.

Parameters:

key - the key for which the translations are held

Method Detail

isAutocreated

public boolean isAutocreated()

Returns true if the translation was auto created as it was missing in the .properties files.

Returns:

true if the translation is auto created, false otherwise

setAutocreated

protected void setAutocreated(boolean autocreated)

Sets the the autocreated flag.

Parameters:

autocreated - determines if the translation was automatically created by the system (true).

setFile

protected void setFile(String file)

Sets the name of the file in which the property is defined.

Parameters:

file - the name of the file in which the property is defined

getFile

public String getFile()

Returns the name of the file in which the property is defined.

Returns:

the name of the file in which the property is defined

addTranslation

public void addTranslation(String lang,
                           String value,
                           boolean silent)

Adds a translation for the given language.

Parameters:

lang - a two-letter language code for which the given translation should be used

value - the translation for the given language

silent - determines if a warning is issued if an existing translation is overridden. Setting silent to true will prevent such warnings and is used to load customer specific translations which purpose is ti override existing translations.

getKey

public String getKey()

Returns the key for which the translation can be found

Returns:

the name of the key used to register the translation

isAccessed

public boolean isAccessed()

Determines whether the translation was already accessed

Returns:

true if the translation was already accessed, false otherwise

translate

public String translate(String lang)

Returns the translation for the given language

Parameters:

lang - the language as two-letter code

Returns:

a translation in the requested language or the key if no translation was found

translateWithoutFallback

public String translateWithoutFallback(String lang)

Returns the translation for the given language

Parameters:

lang - the language as two-letter code

Returns:

a translation in the requested language or null if no translation was found

hasTranslation

public boolean hasTranslation(String lang)

Determines if a translation for the given language is available

Parameters:

lang - the language as two-letter code

Returns:

true if a translation for the given language exists, false otherwise

containsText

protected boolean containsText(String effectiveFilter)

Checks if the given filter is either contained in the key or in one of the translations

Parameters:

effectiveFilter - the filter to be applied. null indicates that no filtering should take place

Returns:

true if the given filter was null or if it either occurred in the key or in one of the translations.

writeTo

protected void writeTo(Map<String,sirius.kernel.nls.SortedProperties> propMap)

Writes all translations into the given map

Parameters:

propMap - the target map with maps two-letter language codes to StoredProperties