com.basistech.rosette.apimodel

Class NameTranslationRequest.Builder

java.lang.Object

com.basistech.rosette.apimodel.NameTranslationRequest.Builder

Enclosing class:

NameTranslationRequest

public static class NameTranslationRequest.Builder
extends Object

Fluent builder class for NameTranslationRequest.

Constructor Summary

Constructors

Constructor and Description
Builder(String name, com.basistech.util.LanguageCode targetLanguage)

Method Summary

Modifier and Type	Method and Description
NameTranslationRequest	build()
String	entityType()
NameTranslationRequest.Builder	entityType(String entityType) Specify the type of name (e.g.
com.basistech.util.LanguageCode	sourceLanguageOfOrigin()
NameTranslationRequest.Builder	sourceLanguageOfOrigin(com.basistech.util.LanguageCode sourceLanguageOfOrigin) Specify the source language of origin.
com.basistech.util.LanguageCode	sourceLanguageOfUse()
NameTranslationRequest.Builder	sourceLanguageOfUse(com.basistech.util.LanguageCode sourceLanguageOfUse) Specify the source language of use.
com.basistech.util.ISO15924	sourceScript()
NameTranslationRequest.Builder	sourceScript(com.basistech.util.ISO15924 sourceScript) Specify the script of the source name.
NameTranslationRequest.Builder	targetScheme(com.basistech.util.TransliterationScheme targetScheme) Specify the transliteration scheme.
NameTranslationRequest.Builder	targetScript(com.basistech.util.ISO15924 targetScript) Specify the target script.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String name,
               com.basistech.util.LanguageCode targetLanguage)

Method Detail

targetScript

public NameTranslationRequest.Builder targetScript(com.basistech.util.ISO15924 targetScript)

Specify the target script.

Parameters:

targetScript - the script.

Returns:

this.

targetScheme

public NameTranslationRequest.Builder targetScheme(com.basistech.util.TransliterationScheme targetScheme)

Specify the transliteration scheme. The default depends on the source and target languages.

Parameters:

targetScheme - the scheme.

Returns:

this.

entityType

public NameTranslationRequest.Builder entityType(String entityType)

Specify the type of name (e.g. PERSON, ORGANIZATION). By default, the translation does not take a type into account.

Parameters:

entityType - the type.

Returns:

this.

entityType

public String entityType()

Returns:

the entity type.

sourceScript

public NameTranslationRequest.Builder sourceScript(com.basistech.util.ISO15924 sourceScript)

Specify the script of the source name. By default, this is auto-detected.

Parameters:

sourceScript - the script.

Returns:

this.

sourceScript

public com.basistech.util.ISO15924 sourceScript()

Returns:

the source script.

sourceLanguageOfUse

public NameTranslationRequest.Builder sourceLanguageOfUse(com.basistech.util.LanguageCode sourceLanguageOfUse)

Specify the source language of use. By default, this is auto-detected.

Parameters:

sourceLanguageOfUse - the language.

Returns:

this.

sourceLanguageOfUse

public com.basistech.util.LanguageCode sourceLanguageOfUse()

Returns:

the source language of use.

sourceLanguageOfOrigin

public NameTranslationRequest.Builder sourceLanguageOfOrigin(com.basistech.util.LanguageCode sourceLanguageOfOrigin)

Specify the source language of origin. By default, it is the same as the source language of use.

Parameters:

sourceLanguageOfOrigin - the language.

Returns:

this.

sourceLanguageOfOrigin

public com.basistech.util.LanguageCode sourceLanguageOfOrigin()

Returns:

the source language of use.

build

public NameTranslationRequest build()

Returns:

the request object.