com.basistech.rosette.apimodel

Class Request

java.lang.Object

com.basistech.rosette.apimodel.Request

Direct Known Subclasses:

CategoriesRequest, EntitiesRequest, LanguageRequest, LinkedEntitiesRequest, MorphologyRequest, RelationshipsRequest, SentencesRequest, SentimentRequest

public abstract class Request
extends Object

This class represents the common information for all document processing requests to the Rosette API. Most applications do not use this class directly; the methods of the RosetteAPI class create request objects. More complex applications may create objects of the subclasses of this class for themselves via the fluent Builder classes.
On the wire, a request is a json object. All the endpoints accept the same set of items, represented here, that describe the input document text.
Applications specify the text to process in three ways:

1. Plain text, as the content item in the Json object.
2. A binary file image, attached as an additional MIME part to the request. The application provides a MIME content type in contentType.
3. A URL of a data to download. The application provides the URL in contentUri. Note that the Rosette API respects the content type returned by the server for downloaded data.

In this object the 'content' item is an Object; it contains a String for plain text, and an InputStream for binary data. Request.Builder provides several alternative methods for setting this information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.Builder<T extends Request,O,B extends Request.Builder<T,O,B>> Base class for builders for the request objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Request(com.basistech.util.LanguageCode language, Object content, String contentUri, String contentType) Constructor for Request

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) if the param is a Request, compare contents for equality
String	getContent() get content to process if it's a String.
InputStream	getContentBytes() get the content as an array of bytes
String	getContentType() get the content type
String	getContentUri() get the URI to accessible content (content and contentURI are mutually exlcusive)
com.basistech.util.LanguageCode	getLanguage() get the language code
Object	getRawContent()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

protected Request(com.basistech.util.LanguageCode language,
                  Object content,
                  String contentUri,
                  String contentType)

Constructor for Request

Parameters:

language - language code

content - raw data

contentUri - uri pointing to the data

contentType - byte array of data

Method Detail

getLanguage

public com.basistech.util.LanguageCode getLanguage()

get the language code

Returns:

the language code

getContent

public String getContent()

get content to process if it's a String.

Returns:

the content if a String, else null.

getContentBytes

public InputStream getContentBytes()

get the content as an array of bytes

Returns:

the content as bytes

getRawContent

public Object getRawContent()

getContentUri

public String getContentUri()

get the URI to accessible content (content and contentURI are mutually exlcusive)

Returns:

the content URI

getContentType

public String getContentType()

get the content type

Returns:

the content type

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

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