org.jiim.translation
Interface ITranslationEngine

All Known Implementing Classes:

TranslationEngineAltavistaImpl, TranslationEngineBaseImpl, TranslationEngineGoogleImpl

public interface ITranslationEngine

The signature for any translation engine implementation

Author:

Jorge De Castro

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.net.URL	getUrl()
void	setProperties(java.util.Map<java.lang.String,java.lang.String> params) Set the optional key/value pairs of parameters needed to access the translation service API
void	setUrl(java.net.URL url) The URL of the translation service, e.g.: 'http://babelfish.altavista.com/tr'
java.lang.String	translate(java.lang.String fromLanguage, java.lang.String toLanguage, java.lang.String text) Translates 'text' from a given 'fromLanguage' into a given 'toLanguage'

Method Detail

setUrl

void setUrl(java.net.URL url)
            throws java.net.MalformedURLException

The URL of the translation service, e.g.: 'http://babelfish.altavista.com/tr'

Parameters:

url -

Throws:

java.net.MalformedURLException

getUrl

java.net.URL getUrl()

Returns:

URL of translation engine

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.String> params)

Set the optional key/value pairs of parameters needed to access the translation service API

Parameters:

params -

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns:

Map containing key/value pairs of parameters needed to access the translation service API

translate

java.lang.String translate(java.lang.String fromLanguage,
                           java.lang.String toLanguage,
                           java.lang.String text)
                           throws TranslationException

Translates 'text' from a given 'fromLanguage' into a given 'toLanguage'

Parameters:

fromLanguage -

toLanguage -

text -

Returns:

Throws:

java.lang.Exception

TranslationException