Class YandexTranslator

  • All Implemented Interfaces:
    Translator

    public class YandexTranslator
    extends Object
    implements Translator
    An implementation of a REST client for the YANDEX Translate API. You can sign up for free access online on the API Key form and set your Application's User Key in the translator.yandex.properties file.
    • Constructor Detail

      • YandexTranslator

        public YandexTranslator()
    • Method Detail

      • translate

        public String translate​(String text,
                                String sourceLanguage,
                                String targetLanguage)
                         throws TikaException,
                                IOException
        Description copied from interface: Translator
        Translate text between given languages.
        Specified by:
        translate in interface Translator
        Parameters:
        text - The text to translate.
        sourceLanguage - The input text language (for example, "en").
        targetLanguage - The desired language to translate to (for example, "fr").
        Returns:
        The translation result. If translation is unavailable, returns the same text back.
        Throws:
        TikaException - When there is an error translating.
        IOException
      • getApiKey

        public String getApiKey()
        Get the API Key in use for client authentication
        Returns:
        API Key
      • setApiKey

        public void setApiKey​(String apiKey)
        Set the API Key for client authentication
        Parameters:
        apiKey - API Key
      • getFormat

        public String getFormat()
        Retrieve the current text format setting. The Yandex Translate API can handle text in plain and/or html format, the default format is plain
        Returns:
      • setFormat

        public void setFormat​(String format)
        Set the text format to use (plain/html)
        Parameters:
        format - Text format setting, either plain or html
      • translate

        public String translate​(String text,
                                String targetLanguage)
                         throws TikaException,
                                IOException
        Description copied from interface: Translator
        Translate text to the given language This method attempts to auto-detect the source language of the text.
        Specified by:
        translate in interface Translator
        Parameters:
        text - The text to translate.
        targetLanguage - The desired language to translate to (for example, "hi").
        Returns:
        The translation result. If translation is unavailable, returns the same text back.
        Throws:
        TikaException - When there is an error translating.
        IOException
      • isAvailable

        public boolean isAvailable()
        Specified by:
        isAvailable in interface Translator
        Returns:
        true if this Translator is probably able to translate right now.