org.gomoob.model.translation

Class Translation

java.lang.Object

org.gomoob.model.translation.Translation

All Implemented Interfaces:

ITranslation

public class Translation
extends Object
implements ITranslation

Class which define translations for multiple attributes.

Author:

Simon BAUDRY (simon.baudry@gomoob.com)

Constructor Summary

Constructors

Constructor and Description
Translation()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Translation

public Translation()

Method Detail

getAttributeTranslation

public String getAttributeTranslation(String attributeName)

Gets the translation associated to an attribute.

Specified by:

getAttributeTranslation in interface ITranslation

Parameters:

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

Returns:

The found translation.

getAttributeTranslations

public Map<String,String> getAttributeTranslations()

Gets all the attribute translations which have been registered.

Specified by:

getAttributeTranslations in interface ITranslation

Returns:

All the attribute translations which have been registered.

getLanguageCode

public 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.

Specified by:

getLanguageCode in interface ITranslation

Returns:

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

setAttributeTranslation

public void setAttributeTranslation(String attributeName,
                                    String attributeValue)

Add a translated attribute or update an existing one.

Specified by:

setAttributeTranslation in interface ITranslation

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

public 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.

Specified by:

setLanguageCode in interface ITranslation

Parameters:

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