io.redlink.sdk.impl.analysis

Class AnalysisRequest

java.lang.Object

io.redlink.sdk.impl.analysis.AnalysisRequest

public class AnalysisRequest
extends Object

Represent a Request Object necessary to perform RedLink.Analysis services' requests. An instance of this class contains all the parameters that can be used for profiling a request to the RedLink RedLink.Analysis service. In order to build such instances, AnalysisRequest.AnalysisRequestBuilder must be used

Author:

Rafa Haro, Sergio Fernández

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalysisRequest.AnalysisRequestBuilder Analysis Request Builder.
static class	AnalysisRequest.InputFormat Accepted Input Formats
static class	AnalysisRequest.OutputFormat Accepted Output Formats

Constructor Summary

Constructors

Constructor and Description
AnalysisRequest()

Method Summary

Modifier and Type	Method and Description
static AnalysisRequest.AnalysisRequestBuilder	builder() Create a new Request Builder
String	getAnalysis() Get current request analysis name
double	getConfidence() Get current request confidence parameter
InputStream	getContent() Get current request content as InputStream
Collection<String>	getFieldsToDereference()
String	getInputFormat() Return current request AnalysisRequest.InputFormat name.
com.google.common.net.MediaType	getInputMediaType() Return current request AnalysisRequest.InputFormat MediaType.
String	getLDPathProgram()
String	getOutputFormat() Return current request AnalysisRequest.OutputFormat name.
com.google.common.net.MediaType	getOutputMediaType() Return current request AnalysisRequest.OutputFormat's MediaType .
boolean	getSummary() Get current request summary parameter
boolean	getThumbnail() Get current request thumbnail parameter

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalysisRequest

public AnalysisRequest()

Method Detail

getInputFormat

public String getInputFormat()

Return current request AnalysisRequest.InputFormat name. The input format should be used to specify the format of the content that is sent to analyze

Returns:

Current Request AnalysisRequest.InputFormat's name

getInputMediaType

public com.google.common.net.MediaType getInputMediaType()

Return current request AnalysisRequest.InputFormat MediaType. The input format should be used to specify the format of the content that is sent to analyze

Returns:

Current Request AnalysisRequest.InputFormat's MediaType

getOutputFormat

public String getOutputFormat()

Return current request AnalysisRequest.OutputFormat name. The output format should be used to specify the format of the analysis service response

Returns:

Current Request AnalysisRequest.OutputFormat's name

getOutputMediaType

public com.google.common.net.MediaType getOutputMediaType()

Return current request AnalysisRequest.OutputFormat's MediaType . The output format should be used to specify the format of the analysis service response

Returns:

Current Request AnalysisRequest.OutputFormat's MediaType

getContent

public InputStream getContent()

Get current request content as InputStream

Returns:

InputStream containing the content that is going to be analyzed

getAnalysis

public String getAnalysis()

Get current request analysis name

Returns:

User's RedLink Application Analysis name for the current request

getSummary

public boolean getSummary()

Get current request summary parameter

Returns:

Flag indicating if current request will ask analysis service to return entities's summaries

getConfidence

public double getConfidence()

Get current request confidence parameter

Returns:

Current request confidence parameter

getThumbnail

public boolean getThumbnail()

Get current request thumbnail parameter

Returns:

Flag indicating if current request will ask analysis service to return entities's thumbnails

getFieldsToDereference

public Collection<String> getFieldsToDereference()

getLDPathProgram

public String getLDPathProgram()

builder

public static AnalysisRequest.AnalysisRequestBuilder builder()

Create a new Request Builder

Returns:

Created AnalysisRequest.AnalysisRequestBuilder