org.gomoob.model

Interface ITranslation

All Known Implementing Classes:

Translation

public interface ITranslation

Interface which represents an Translation Entity.

Author:

Simon BAUDRY (simon.baudry@gomoob.com)

Method Summary

Modifier and Type	Method and Description
String	getAttributeTranslation(String attributeName) Gets the translation associated to an attribute.
Map<String,String>	getAttributeTranslations() Gets all the attribute translations which have been registered.
String	getLanguageCode() Gets the language code which define the language associated to the translations.
void	setAttributeTranslation(String attributeName, String attributeValue) Add a translated attribute or update an existing one.
void	setLanguageCode(String languageCode) Sets the language code which define the language associated to the translations.

Method Detail

getAttributeTranslation

String getAttributeTranslation(String attributeName)

Gets the translation associated to an attribute.

Parameters:

attributeName - The name of the attribute for which one to get translations.

Returns:

The found translation.

Throws:

IllegalStateException - If no attribute translation corresponds to the specified name.

getAttributeTranslations

Map<String,String> getAttributeTranslations()

Gets all the attribute translations which have been registered.

Returns:

All the attribute translations which have been registered.

getLanguageCode

String getLanguageCode()

Gets the language code which define the language associated to the translations. This language code defines in which language the attributes are set in this object.

WARNING: The language code returned by this function is always expressed in uppercase even if you set it using a lower case syntax. The translation class always stores language codes using an upper case syntax.

Returns:

The language code which define the language associated to the translations. This string is compliant with the ISO639-1 language.

setAttributeTranslation

void setAttributeTranslation(String attributeName,
                             String attributeValue)

Add a translated attribute or update an existing one.

Parameters:

attributeName - The name of the translated attribute.

attributeValue - The value of the translated attribute, the language associated to this value is defined by the `getLanguageCode()` and `setLanguageCode()` functions.

setLanguageCode

void setLanguageCode(String languageCode)

Sets the language code which define the language associated to the translations. This language code defines in which language the attributes are set in this object.

WARNING: The provided language code is not case sensitive, but, internally the language code which is used and stored is ALWAYS converted in uppercase.

Parameters:

languageCode - The language code to set, this string must be compliant with the ISO639-1 standard.