com.austinv11.collectiveframework.language.translation

Interface ITranslationProvider

All Known Implementing Classes:

YandexProvider

public interface ITranslationProvider

Class for a translation provider

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDetectLanguage() Used by the TranslationManager internally
java.lang.String	detectLangauge(java.lang.String text) Method to detect the language from a string, only used if canDetectLanguage() returns true
java.lang.String	getProviderName() Method for receiving the name of the translation provider
java.lang.String	translate(java.lang.String text, java.lang.String toLang) Method to actually translate, only used if canDetectLanguage() returns true
java.lang.String	translate(java.lang.String text, java.lang.String fromLang, java.lang.String toLang) Method to actually translate

Method Detail

getProviderName

java.lang.String getProviderName()

Method for receiving the name of the translation provider

Returns:

The name, like "Google Translate"

translate

java.lang.String translate(java.lang.String text,
                         java.lang.String fromLang,
                         java.lang.String toLang)
                           throws TranslationException,
                                  QueryLimitException,
                                  java.io.IOException

Method to actually translate

Parameters:

text - Text to translate

fromLang - Language to translate from

toLang - The language to translate to

Returns:

The translated string

Throws:

TranslationException

QueryLimitException

java.io.IOException

translate

java.lang.String translate(java.lang.String text,
                         java.lang.String toLang)
                           throws TranslationException,
                                  QueryLimitException,
                                  java.io.IOException

Method to actually translate, only used if canDetectLanguage() returns true

Parameters:

text - Text to translate

toLang - The language to translate to

Returns:

The translated string

Throws:

TranslationException

QueryLimitException

java.io.IOException

canDetectLanguage

boolean canDetectLanguage()

Used by the TranslationManager internally

Returns:

Whether this translation provider can detect a language from text

detectLangauge

java.lang.String detectLangauge(java.lang.String text)
                                throws java.io.IOException,
                                       QueryLimitException

Method to detect the language from a string, only used if canDetectLanguage() returns true

Parameters:

text - String to translate

Returns:

The language

Throws:

java.io.IOException

QueryLimitException