Package com.basistech.rosette.api.common

Class AbstractRosetteAPI

java.lang.Object

com.basistech.rosette.api.common.AbstractRosetteAPI

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

HttpRosetteAPI

public abstract class AbstractRosetteAPI
extends Object
implements AutoCloseable

This class defines the common API to Analytics, whether over HTTP or other integration mechanisms.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDRESS_SIMILARITY_SERVICE_PATH
static final String	CATEGORIES_SERVICE_PATH
static final Set<String>	DOC_ENDPOINTS
static final String	ENTITIES_SERVICE_PATH
static final String	EVENTS_SERVICE_PATH
static final String	INFO_SERVICE_PATH
static final String	LANGUAGE_SERVICE_PATH
static final String	MORPHOLOGY_SERVICE_PATH
static final String	NAME_DEDUPLICATION_SERVICE_PATH
static final String	NAME_SIMILARITY_SERVICE_PATH
static final String	NAME_TRANSLATION_SERVICE_PATH
static final Set<String>	NAMES_ENDPOINTS
static final String	PING_SERVICE_PATH
static final String	RECORD_SIMILARITY_SERVICE_PATH
static final String	RELATIONSHIPS_SERVICE_PATH
static final String	SEMANTIC_VECTORS_SERVICE_PATH
static final String	SENTENCES_SERVICE_PATH
static final String	SENTIMENT_SERVICE_PATH
static final String	SIMILAR_TERMS_SERVICE_PATH
static final String	SUPPORTED_LANGUAGES_SUBPATH
static final String	SYNTAX_DEPENDENCIES_SERVICE_PATH
static final String	TEXT_EMBEDDING_SERVICE_PATH
static final String	TOKENS_SERVICE_PATH
static final String	TOPICS_SERVICE_PATH
static final String	TRANSLITERATION_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
AbstractRosetteAPI()

Method Summary

Modifier and Type	Method	Description
abstract com.basistech.rosette.apimodel.SupportedLanguagePairsResponse	getSupportedLanguagePairs(String endpoint)	Gets the set of language, script codes and transliteration scheme pairs supported by the specified Analytics API endpoint.
abstract com.basistech.rosette.apimodel.SupportedLanguagesResponse	getSupportedLanguages(String endpoint)	Gets the set of language and script codes supported by the specified Analytics API endpoint.
abstract <RequestType extends com.basistech.rosette.apimodel.Request> com.basistech.rosette.dm.AnnotatedText	perform(String endpoint, RequestType request)	Perform a request to an endpoint of the Analytics API.
abstract <RequestType extends com.basistech.rosette.apimodel.Request, ResponseType extends com.basistech.rosette.apimodel.Response> ResponseType	perform(String endpoint, RequestType request, Class<ResponseType> responseClass)	Perform a request to an endpoint of the Analytics API.
abstract <RequestType extends com.basistech.rosette.apimodel.Request, ResponseType extends com.basistech.rosette.apimodel.Response> Future<ResponseType>	performAsync(String endpoint, RequestType request, Class<ResponseType> responseClass)	Start an asynchronous request to an endpoint of the Analytics API.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Details

LANGUAGE_SERVICE_PATH

public static final String LANGUAGE_SERVICE_PATH

See Also:

• Constant Field Values

MORPHOLOGY_SERVICE_PATH

public static final String MORPHOLOGY_SERVICE_PATH

See Also:

• Constant Field Values

ENTITIES_SERVICE_PATH

public static final String ENTITIES_SERVICE_PATH

See Also:

• Constant Field Values

CATEGORIES_SERVICE_PATH

public static final String CATEGORIES_SERVICE_PATH

See Also:

• Constant Field Values

RELATIONSHIPS_SERVICE_PATH

public static final String RELATIONSHIPS_SERVICE_PATH

See Also:

• Constant Field Values

SENTIMENT_SERVICE_PATH

public static final String SENTIMENT_SERVICE_PATH

See Also:

• Constant Field Values

NAME_DEDUPLICATION_SERVICE_PATH

public static final String NAME_DEDUPLICATION_SERVICE_PATH

See Also:

• Constant Field Values

NAME_TRANSLATION_SERVICE_PATH

public static final String NAME_TRANSLATION_SERVICE_PATH

See Also:

• Constant Field Values

NAME_SIMILARITY_SERVICE_PATH

public static final String NAME_SIMILARITY_SERVICE_PATH

See Also:

• Constant Field Values

RECORD_SIMILARITY_SERVICE_PATH

public static final String RECORD_SIMILARITY_SERVICE_PATH

See Also:

• Constant Field Values

ADDRESS_SIMILARITY_SERVICE_PATH

public static final String ADDRESS_SIMILARITY_SERVICE_PATH

See Also:

• Constant Field Values

TOKENS_SERVICE_PATH

public static final String TOKENS_SERVICE_PATH

See Also:

• Constant Field Values

SENTENCES_SERVICE_PATH

public static final String SENTENCES_SERVICE_PATH

See Also:

• Constant Field Values

TEXT_EMBEDDING_SERVICE_PATH

public static final String TEXT_EMBEDDING_SERVICE_PATH

See Also:

• Constant Field Values

SEMANTIC_VECTORS_SERVICE_PATH

public static final String SEMANTIC_VECTORS_SERVICE_PATH

See Also:

• Constant Field Values

SIMILAR_TERMS_SERVICE_PATH

public static final String SIMILAR_TERMS_SERVICE_PATH

See Also:

• Constant Field Values

SYNTAX_DEPENDENCIES_SERVICE_PATH

public static final String SYNTAX_DEPENDENCIES_SERVICE_PATH

See Also:

• Constant Field Values

TRANSLITERATION_SERVICE_PATH

public static final String TRANSLITERATION_SERVICE_PATH

See Also:

• Constant Field Values

TOPICS_SERVICE_PATH

public static final String TOPICS_SERVICE_PATH

See Also:

• Constant Field Values

INFO_SERVICE_PATH

public static final String INFO_SERVICE_PATH

See Also:

• Constant Field Values

PING_SERVICE_PATH

public static final String PING_SERVICE_PATH

See Also:

• Constant Field Values

SUPPORTED_LANGUAGES_SUBPATH

public static final String SUPPORTED_LANGUAGES_SUBPATH

See Also:

• Constant Field Values

EVENTS_SERVICE_PATH

public static final String EVENTS_SERVICE_PATH

See Also:

• Constant Field Values

DOC_ENDPOINTS

public static final Set<String> DOC_ENDPOINTS

NAMES_ENDPOINTS

public static final Set<String> NAMES_ENDPOINTS

Constructor Details

AbstractRosetteAPI

public AbstractRosetteAPI()

Method Details

getSupportedLanguages

public abstract com.basistech.rosette.apimodel.SupportedLanguagesResponse getSupportedLanguages(String endpoint)
                                                                                         throws com.basistech.rosette.apimodel.CommonRosetteAPIException

Gets the set of language and script codes supported by the specified Analytics API endpoint.

Parameters:

endpoint - Analytics API endpoint.

Returns:

SupportedLanguagesResponse

Throws:

com.basistech.rosette.apimodel.CommonRosetteAPIException - for an error.

getSupportedLanguagePairs

public abstract com.basistech.rosette.apimodel.SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint)
                                                                                                 throws com.basistech.rosette.apimodel.CommonRosetteAPIException

Gets the set of language, script codes and transliteration scheme pairs supported by the specified Analytics API endpoint.

Parameters:

endpoint - Analytics API endpoint.

Returns:

SupportedLanguagePairsResponse

Throws:

com.basistech.rosette.apimodel.CommonRosetteAPIException - for an error returned from the Rosette API.

perform

public abstract <RequestType extends com.basistech.rosette.apimodel.Request,
ResponseType extends com.basistech.rosette.apimodel.Response>
ResponseType perform(String endpoint,
 RequestType request,
 Class<ResponseType> responseClass)
              throws com.basistech.rosette.apimodel.CommonRosetteAPIException

Perform a request to an endpoint of the Analytics API.

Type Parameters:

RequestType - The class of the request object for this endpoint.

ResponseType - the class of the response object for this endpoint.

Parameters:

endpoint - which endpoint.

request - the data for the request.

responseClass - the Java Class object for the response object.

Returns:

the response.

Throws:

com.basistech.rosette.apimodel.CommonRosetteAPIException - for an error.

perform

public abstract <RequestType extends com.basistech.rosette.apimodel.Request>
com.basistech.rosette.dm.AnnotatedText perform(String endpoint,
 RequestType request)
                                        throws com.basistech.rosette.apimodel.CommonRosetteAPIException

Perform a request to an endpoint of the Analytics API.

Type Parameters:

RequestType - The class of the request object for this endpoint.

Parameters:

endpoint - which endpoint.

request - the data for the request.

Returns:

the response, AnnotatedText.

Throws:

com.basistech.rosette.apimodel.CommonRosetteAPIException - for an error.

performAsync

public abstract <RequestType extends com.basistech.rosette.apimodel.Request,
ResponseType extends com.basistech.rosette.apimodel.Response>
Future<ResponseType> performAsync(String endpoint,
 RequestType request,
 Class<ResponseType> responseClass)
                           throws com.basistech.rosette.apimodel.CommonRosetteAPIException

Start an asynchronous request to an endpoint of the Analytics API.

Type Parameters:

RequestType - The class of the request object for this endpoint.

ResponseType - the class of the response object for this endpoint.

Parameters:

endpoint - which endpoint.

request - the data for the request.

responseClass - the Java Class object for the response object.

Returns:

a Future for the response.

Throws:

com.basistech.rosette.apimodel.CommonRosetteAPIException - for an error.