org.jahia.services.translation

Class TranslationService

java.lang.Object

org.jahia.services.translation.TranslationService

public class TranslationService
extends Object

Service to translate text using an online translation service. Several TranslationProviders can be contributed, each one representing an online service.

Constructor Summary

Constructors

Constructor and Description
TranslationService()

Method Summary

Modifier and Type	Method and Description
void	addProvider(TranslationProvider provider)
boolean	isEnabled(JCRSiteNode site) Checks if one provider is enabled for a given site.
List<String>	translate(List<String> texts, String srcLanguage, String destLanguage, boolean isHtml, JCRSiteNode site, Locale uiLocale) Calls the translate method from the first enabled TranslationProvider with a list of texts to translate.
String	translate(String text, String srcLanguage, String destLanguage, boolean isHtml, JCRSiteNode site, Locale uiLocale) Calls the translate method from the first enabled TranslationProvider with a single text to translate.

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslationService

public TranslationService()

Method Detail

translate

public String translate(String text,
                        String srcLanguage,
                        String destLanguage,
                        boolean isHtml,
                        JCRSiteNode site,
                        Locale uiLocale)
                 throws TranslationException

Calls the translate method from the first enabled TranslationProvider with a single text to translate. If the text is blank, it's just returned without calling the TranslationProvider.

Parameters:

text - a text to translate

srcLanguage - the source language code

destLanguage - the destination language code

isHtml - is the text html or plain text

site - the site

uiLocale -

Returns:

the translated text

Throws:

TranslationException

translate

public List<String> translate(List<String> texts,
                              String srcLanguage,
                              String destLanguage,
                              boolean isHtml,
                              JCRSiteNode site,
                              Locale uiLocale)
                       throws TranslationException

Calls the translate method from the first enabled TranslationProvider with a list of texts to translate. If the list contains only one text, the single text method is called. Blank texts are not passed to the TranslationProvider.

Parameters:

texts - a list of texts to translate

srcLanguage - the source language code

destLanguage - the destination language code

isHtml - are the texts html or plain texts

site - the site

uiLocale -

Returns:

the translated texts

Throws:

TranslationException

isEnabled

public boolean isEnabled(JCRSiteNode site)

Checks if one provider is enabled for a given site.

Parameters:

site - a site

Returns:

a boolean

addProvider

public void addProvider(TranslationProvider provider)