org.gomoob.model

Interface ITranslatableEntity<IDT extends Serializable>

Type Parameters:

IDT - the type of the technical identifier associated to this entity.

All Superinterfaces:

IEntity<IDT>

All Known Subinterfaces:

ITranslatableEntityWithCreationDate<IDT>, ITranslatableEntityWithCreationDateAndUpdateDate<IDT>

All Known Implementing Classes:

AbstractTranslatableEntity, AbstractTranslatableEntityWithCreationDate, AbstractTranslatableEntityWithCreationDateAndUpdateDate

public interface ITranslatableEntity<IDT extends Serializable>
extends IEntity<IDT>

Interface which represents a Translatable Business Entity.

Author:

Simon BAUDRY (simon.baudry@gomoob.com)

Method Summary

Modifier and Type	Method and Description
void	applyTranslation(String languageCode) Apply an existing translation on this translatable entity.
void	deleteTranslation(String languageCode) Deletes an existing translation from this translatable entity.
void	deleteTranslations(List<String> languageCodes) Function used to delete one or multiple existing translations from the entity.
String	getDefaultLanguageCode() Gets the language code which was used when the entity was created.
ITranslation	getTranslation(String languageCode) Gets a translation (corresponding to a specified language code) for the entity.
String	getTranslationLanguageCode() Gets the language code associated to translations which have been applied to the entity.
Map<String,ITranslation>	getTranslations() Gets multiple translations in multiple languages for this translatable entity.
Boolean	isTranslated() Function used to indicate if the entity has been translated of if its fields are in its default language.
void	setDefaultLanguageCode(String defaultLanguageCode) Sets the language code which was used when the entity was created.
void	setTranslation(ITranslation translation) Adds a new translation or update an existing one for the entity.
void	setTranslationLanguageCode(String translationLanguageCode) Sets the language code associated to the translations which have been applied to the entity.
void	setTranslations(Map<String,ITranslation> translations) Sets multiple translations in multiple languages for this translatable entity.

Methods inherited from interface org.gomoob.model.IEntity

get, getId, set, setId

Method Detail

applyTranslation

void applyTranslation(String languageCode)

Apply an existing translation on this translatable entity.

Parameters:

languageCode - The code of the targeted language translation.

Throws:

IllegalStateException - If no translation with the language code `languageCode` has been found.

deleteTranslation

void deleteTranslation(String languageCode)

Deletes an existing translation from this translatable entity.

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 code of the language for which one to delete a translation.

Throws:

IllegalStateException - If no translation with the language code `languageCode` has not been registered.

deleteTranslations

void deleteTranslations(List<String> languageCodes)

Function used to delete one or multiple existing translations from the entity.

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

Parameters:

languageCodes - An array with language codes associated to translations to be deleted, if this parameter is `null` then all the translations are deleted.

Throws:

IllegalStateException - if one (or more) translation with one of the provided language has not been registered. If this exception is thrown then the translatable entity is not modified.

getDefaultLanguageCode

String getDefaultLanguageCode()

Gets the language code which was used when the entity was created. In most cases this is the language which was used by the user who created the entity.

WARNING: The language code returned by this function is always expressed in uppercase even if you provided a language code to the entity using a lower case syntax. Internally translatable entities always store language codes in upper case.

Returns:

The default language code, the returned string is compliant with the ISO639-1 standard.

getTranslation

ITranslation getTranslation(String languageCode)

Gets a translation (corresponding to a specified language code) for the entity. This function picks on of the translation returned by the `getTranslations()` function.

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 for which one to get a translation.

Returns:

The found translation.

Throws:

IllegalStateException - if no translation have been found for the specified language code.

getTranslationLanguageCode

String getTranslationLanguageCode()

Gets the language code associated to translations which have been applied to the entity. The translation language code is only set if the entity is translated (that's to say its fields are translated in a different language than the default language code).

The translation language code should only be used when you have to translate an entity in one language to display informations on a GUI (also in one language). If you have to create a GUI for persons responsible of the translations (i.e the translators) then you'll need to attach all the available translations in all languages to you entities. In this cas you should used the `getTranslations()` and `setTranslations()` functions to manage a list of all the translations in all languages attached to the entity. WARNING: The provided language code is not case sensitive, but, internally the language code which is used and stored is ALWAYS converted in uppercase.

Returns:

The translation language code, the returned string is compliant with ISO639-1 standard.

getTranslations

Map<String,ITranslation> getTranslations()

Gets multiple translations in multiple languages for this translatable entity. This function is used when you have to display multiple translations in multiple languages on a GUI, in most cases thoses GUIs are dedicated to persons responsible of the translations (i.e the translators). When you use multiple translations in multiple languages attached to an entity the metadata attached to the entity stays in the default language specified by the default language code. The returned multiple translations should not contain translations for the default language.

If you have to display an entity in only one language then do not use the `getTranslations()` and `setTranslations()` function but prefer the `getTranslationLanguageCode()` and `setTranslationLanguageCode()` functions which are used to manage only one translation (i.e in only one language), that's to say to translate the entity in one target language only.

Returns:

The translations in multiple languages attached to this translatable entity.

isTranslated

Boolean isTranslated()

Function used to indicate if the entity has been translated of if its fields are in its default language. An entity is translated when its `translationLanguageCode` is not `null` or if its associated to at least one translation (i.e the `getTranslations()` function returns a not empty array. This function is convenient when, after having trying to translate an entity you want to know if translations for this entity have been found. If no translations have been found the entity should stay intact and should not be modified.

Returns:

`true` if the entity is translated, `false` otherwise.

setDefaultLanguageCode

void setDefaultLanguageCode(String defaultLanguageCode)

Sets the language code which was used when the entity was created. In most cases this is the language which was used by the user who created the entity.

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:

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

setTranslationLanguageCode

void setTranslationLanguageCode(String translationLanguageCode)

Sets the language code associated to the translations which have been applied to the entity. The translation language code must only be set if the entity is translated (that's to say its fields have been translated in a different language than the default language code).

The translation language code should only be used when you have to translate an entity in one language to display informations on a GUI (also in one language). If you have to create a GUI for persons responsible of the translations (i.e the translators) then you'll need to attach all the available translations in all languages to you entities. In this cas you should used the `getTranslations()` and `setTranslations()` functions to manage a list of all the translations in all languages attached to the entity. 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:

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

setTranslation

void setTranslation(ITranslation translation)

Adds a new translation or update an existing one for the entity.

Parameters:

translation - The new translation to add or an existing translation to update.

Throws:

IllegalStateException - if the entity is already translated using a the "one language mode".

setTranslations

void setTranslations(Map<String,ITranslation> translations)

Sets multiple translations in multiple languages for this translatable entity. This function is used when you have to display multiple translations in multiple languages on a GUI, in most cases thoses GUIs are dedicated to persons responsible of the translations (i.e the translators). When you use multiple translations in multiple languages attached to an entity the metadata attached to the entity stays in the default language specified by the default language code. The returned multiple translations should not contain translations for the default language.

If you have to display an entity in only one language then do not use the `getTranslations()` and `setTranslations()` function but prefer the `getTranslationLanguageCode()` and `setTranslationLanguageCode()` functions which are used to manage only one translation (i.e in only one language), that's to say to translate the entity in one target language only.

Parameters:

translations - The translations to set.