org.omegat.core.machinetranslators

Class BaseTranslate

java.lang.Object

org.omegat.core.machinetranslators.BaseTranslate

All Implemented Interfaces:

IMachineTranslation

Direct Known Subclasses:

AbstractMyMemoryTranslate, ApertiumTranslate, BelazarTranslate, DeepLTranslate, Google2Translate, IBMWatsonTranslate, MicrosoftTranslatorAzure, MosesTranslate, YandexCloudTranslate

public abstract class BaseTranslate
extends java.lang.Object
implements IMachineTranslation

Base class for machine translation.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabled
protected IMTGlossarySupplier	glossarySupplier

Constructor Summary

Constructors

Constructor and Description
BaseTranslate()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	cleanSpacesAroundTags(java.lang.String machineText, java.lang.String sourceText) Attempt to clean spaces added around tags by machine translators.
protected void	clearCache() Clear the machine translation cache.
java.lang.String	getCachedTranslation(Language sLang, Language tLang, java.lang.String text) Get cached translation.
protected java.lang.String	getCredential(java.lang.String id) Retrieve a credential with the given ID.
protected java.lang.String	getFromCache(Language sLang, Language tLang, java.lang.String text)
protected abstract java.lang.String	getPreferenceName()
java.lang.String	getTranslation(Language sLang, Language tLang, java.lang.String text) Translate.
protected boolean	isCredentialStoredTemporarily(java.lang.String id) Determine whether a credential has been stored "temporarily" according to the definition in setCredential(String, String, boolean).
boolean	isEnabled() Determine whether or not the MT provider has been enabled by the user.
protected java.lang.String	putToCache(Language sLang, Language tLang, java.lang.String text, java.lang.String result)
protected void	setCredential(java.lang.String id, java.lang.String value, boolean temporary) Store a credential.
void	setEnabled(boolean enabled) Turn the MT provider on or off
void	setGlossarySupplier(IMTGlossarySupplier glossarySupplier) Set a glossary supplier to provide relevant glossary terms if desired.
protected abstract java.lang.String	translate(Language sLang, Language tLang, java.lang.String text)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegat.gui.exttrans.IMachineTranslation

getName, isConfigurable, showConfigurationUI

Field Detail

enabled

protected boolean enabled

glossarySupplier

protected IMTGlossarySupplier glossarySupplier

Constructor Detail

BaseTranslate

public BaseTranslate()

Method Detail

isEnabled

public boolean isEnabled()

Description copied from interface: IMachineTranslation

Determine whether or not the MT provider has been enabled by the user.

Specified by:

isEnabled in interface IMachineTranslation

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: IMachineTranslation

Turn the MT provider on or off

Specified by:

setEnabled in interface IMachineTranslation

setGlossarySupplier

public void setGlossarySupplier(IMTGlossarySupplier glossarySupplier)

Description copied from interface: IMachineTranslation

Set a glossary supplier to provide relevant glossary terms if desired. The terms are provided as a map with keys being the source terms and values being the target terms.

Specified by:

setGlossarySupplier in interface IMachineTranslation

getTranslation

public java.lang.String getTranslation(Language sLang,
                                       Language tLang,
                                       java.lang.String text)
                                throws java.lang.Exception

Description copied from interface: IMachineTranslation

Translate.

Specified by:

getTranslation in interface IMachineTranslation

Parameters:

sLang - source language

tLang - target language

text - text for translation

Returns:

translated text, or null if translation impossible

Throws:

java.lang.Exception

getCachedTranslation

public java.lang.String getCachedTranslation(Language sLang,
                                             Language tLang,
                                             java.lang.String text)

Description copied from interface: IMachineTranslation

Get cached translation. Returns null if translation not present.

Specified by:

getCachedTranslation in interface IMachineTranslation

Parameters:

sLang - source language

tLang - target language

text - text for translation

Returns:

translated text, or null if translation impossible

getPreferenceName

protected abstract java.lang.String getPreferenceName()

translate

protected abstract java.lang.String translate(Language sLang,
                                              Language tLang,
                                              java.lang.String text)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

cleanSpacesAroundTags

protected java.lang.String cleanSpacesAroundTags(java.lang.String machineText,
                                                 java.lang.String sourceText)

Attempt to clean spaces added around tags by machine translators. Do it by comparing spaces between the source text and the machine translated text.

Parameters:

machineText - The text returned by the machine translator

sourceText - The original source segment

Returns:

getFromCache

protected java.lang.String getFromCache(Language sLang,
                                        Language tLang,
                                        java.lang.String text)

putToCache

protected java.lang.String putToCache(Language sLang,
                                      Language tLang,
                                      java.lang.String text,
                                      java.lang.String result)

clearCache

protected void clearCache()

Clear the machine translation cache.

getCredential

protected java.lang.String getCredential(java.lang.String id)

Retrieve a credential with the given ID. First checks temporary system properties, then falls back to the program's persistent preferences. Store a credential with setCredential(String, String, boolean).

Parameters:

id - ID or key of the credential to retrieve

Returns:

the credential value in plain text

setCredential

protected void setCredential(java.lang.String id,
                             java.lang.String value,
                             boolean temporary)

Store a credential. Credentials are stored in temporary system properties and, if temporary is false, in the program's persistent preferences encoded in Base64. Retrieve a credential with getCredential(String).

Parameters:

id - ID or key of the credential to store

value - value of the credential to store

temporary - if false, encode with Base64 and store in persistent preferences as well

isCredentialStoredTemporarily

protected boolean isCredentialStoredTemporarily(java.lang.String id)

Determine whether a credential has been stored "temporarily" according to the definition in setCredential(String, String, boolean). The result will be false if the credential is not stored at all, or if it is stored permanently.

Parameters:

id - ID or key of credential

Returns:

true only if the credential is stored temporarily

See Also:

setCredential(String, String, boolean), getCredential(String)