com.basistech.rosette.apimodel

Class NameTranslationRequest

java.lang.Object

com.basistech.rosette.apimodel.NameTranslationRequest

public final class NameTranslationRequest
extends Object

Class that represents the data from a name translation request

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NameTranslationRequest.Builder Fluent builder class for NameTranslationRequest.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NameTranslationRequest(String name, String entityType, com.basistech.util.ISO15924 sourceScript, com.basistech.util.LanguageCode sourceLanguageOfOrigin, com.basistech.util.LanguageCode sourceLanguageOfUse, com.basistech.util.LanguageCode targetLanguage, com.basistech.util.ISO15924 targetScript, com.basistech.util.TransliterationScheme targetScheme) constructor for NameTranslationRequest

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) if the param is a NameTranslationRequest, compare contents for equality
String	getEntityType() get the entity type of the name
String	getName() get the name to be translated
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 name's script
com.basistech.util.LanguageCode	getTargetLanguage() get 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 target script
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

NameTranslationRequest

protected NameTranslationRequest(String name,
                                 String entityType,
                                 com.basistech.util.ISO15924 sourceScript,
                                 com.basistech.util.LanguageCode sourceLanguageOfOrigin,
                                 com.basistech.util.LanguageCode sourceLanguageOfUse,
                                 com.basistech.util.LanguageCode targetLanguage,
                                 com.basistech.util.ISO15924 targetScript,
                                 com.basistech.util.TransliterationScheme targetScheme)

constructor for NameTranslationRequest

Parameters:

name - name to be translated

entityType - name's entity type

sourceScript - name's script code

sourceLanguageOfOrigin - name's language of origin

sourceLanguageOfUse - name's language of use

targetLanguage - target language code

targetScript - target script code

targetScheme - target transliteration scheme

Method Detail

getName

public String getName()

get the name to be translated

Returns:

the name to be translated

getEntityType

public String getEntityType()

get the entity type of the name

Returns:

the entity type of the name

getSourceScript

public com.basistech.util.ISO15924 getSourceScript()

get the code for the name's script

Returns:

code for the name's script

getSourceLanguageOfOrigin

public com.basistech.util.LanguageCode getSourceLanguageOfOrigin()

get the code for the name's language of origin

Returns:

code for the name's language of origin

getSourceLanguageOfUse

public com.basistech.util.LanguageCode getSourceLanguageOfUse()

get the code for the name's language of use

Returns:

code for the name's language of use

getTargetLanguage

public com.basistech.util.LanguageCode getTargetLanguage()

get code for the translation language

Returns:

code for the translation language

getTargetScript

public com.basistech.util.ISO15924 getTargetScript()

get the code for the target script

Returns:

code for the target script

getTargetScheme

public com.basistech.util.TransliterationScheme getTargetScheme()

get the transliteration scheme for the translation

Returns:

the transliteration scheme for the translation

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

if the param is a NameTranslationRequest, 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