com.basistech.rosette.apimodel

Class NameTranslationResponse

java.lang.Object

com.basistech.rosette.apimodel.Response

com.basistech.rosette.apimodel.NameTranslationResponse

public final class NameTranslationResponse
extends Response

name translation result

Field Summary

Fields inherited from class com.basistech.rosette.apimodel.Response

extendedInformation

Constructor Summary

Constructors

Constructor and Description
NameTranslationResponse(com.basistech.util.ISO15924 sourceScript, com.basistech.util.LanguageCode sourceLanguageOfOrigin, com.basistech.util.LanguageCode sourceLanguageOfUse, String translation, com.basistech.util.LanguageCode targetLanguage, com.basistech.util.ISO15924 targetScript, com.basistech.util.TransliterationScheme targetScheme, Double confidence) constructor for TranslatedNamesResult

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) if the param is a translated name result, compare contents for equality
Double	getConfidence() get the confidence of the translation
com.basistech.util.LanguageCode	getSourceLanguageOfOrigin() get the code for the name's language of origin
com.basistech.util.LanguageCode	getSourceLanguageOfUse() get the code for the name's language of use
com.basistech.util.ISO15924	getSourceScript() get the code for the script of the name to translate
com.basistech.util.LanguageCode	getTargetLanguage() get the code for the translation language
com.basistech.util.TransliterationScheme	getTargetScheme() get the transliteration scheme for the translation
com.basistech.util.ISO15924	getTargetScript() get the code for the translation script
String	getTranslation() get the translation
int	hashCode()

Methods inherited from class com.basistech.rosette.apimodel.Response

getExtendedInformation

Methods inherited from class java.lang.Object

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

Constructor Detail

NameTranslationResponse

public NameTranslationResponse(com.basistech.util.ISO15924 sourceScript,
                               com.basistech.util.LanguageCode sourceLanguageOfOrigin,
                               com.basistech.util.LanguageCode sourceLanguageOfUse,
                               String translation,
                               com.basistech.util.LanguageCode targetLanguage,
                               com.basistech.util.ISO15924 targetScript,
                               com.basistech.util.TransliterationScheme targetScheme,
                               Double confidence)

constructor for TranslatedNamesResult

Parameters:

sourceScript - name's script code

sourceLanguageOfOrigin - name's language of origin

sourceLanguageOfUse - name's language of use

translation - translation

targetLanguage - target language code

targetScript - target script code

targetScheme - target transliteration scheme

confidence - confidence score for result

Method Detail

getSourceScript

public com.basistech.util.ISO15924 getSourceScript()

get the code for the script of the name to translate

Returns:

the source script code

getSourceLanguageOfOrigin

public com.basistech.util.LanguageCode getSourceLanguageOfOrigin()

get the code for the name's language of origin

Returns:

the source language of origin code

getSourceLanguageOfUse

public com.basistech.util.LanguageCode getSourceLanguageOfUse()

get the code for the name's language of use

Returns:

the source language of use code

getTargetLanguage

public com.basistech.util.LanguageCode getTargetLanguage()

get the code for the translation language

Returns:

code for the translation language

getTargetScript

public com.basistech.util.ISO15924 getTargetScript()

get the code for the translation script

Returns:

code for the translation script

getTargetScheme

public com.basistech.util.TransliterationScheme getTargetScheme()

get the transliteration scheme for the translation

Returns:

code for the transliteration scheme

getTranslation

public String getTranslation()

get the translation

Returns:

the translation

getConfidence

public Double getConfidence()

get the confidence of the translation

Returns:

the confidence of the translation

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

if the param is a translated name result, compare contents for equality

Overrides:

equals in class Object

Parameters:

o - the object

Returns:

whether or not the param object is equal to this object