io.redlink.sdk

Interface RedLink.Analysis

All Superinterfaces:

Serializable

All Known Implementing Classes:

RedLinkAnalysisImpl

Enclosing interface:

RedLink

public static interface RedLink.Analysis
extends Serializable

RedLink Analysis API. Any implementation of this interface must have a constructor that receives a Credentials object which will be used for each service request

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIDENCE
static String	DEREF_FIELDS
static String	ENHANCE
static String	LDPATH
static String	PATH
static String	SUMMARY
static String	THUMBNAIL

Method Summary

Modifier and Type	Method and Description
Enhancements	enhance(AnalysisRequest request) Performs an analysis of the content included in the request, getting a Enhancements object as result The analysis result will depend on the configured in the configured application within the used Credentials
<T> T	enhance(AnalysisRequest request, Class<T> responseType) Performs an analysis of the content included in the request getting as response an instance of the Class passed by parameter.

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

ENHANCE

static final String ENHANCE

See Also:

Constant Field Values

CONFIDENCE

static final String CONFIDENCE

See Also:

Constant Field Values

SUMMARY

static final String SUMMARY

See Also:

Constant Field Values

THUMBNAIL

static final String THUMBNAIL

See Also:

Constant Field Values

DEREF_FIELDS

static final String DEREF_FIELDS

See Also:

Constant Field Values

LDPATH

static final String LDPATH

See Also:

Constant Field Values

Method Detail

enhance

Enhancements enhance(AnalysisRequest request)

Performs an analysis of the content included in the request, getting a Enhancements object as result The analysis result will depend on the configured in the configured application within the used Credentials

Parameters:

request - AnalysisRequest containing the request parameters and the content to be enhanced

Returns:

Simplified RedLink Enhancement Structure

enhance

<T> T enhance(AnalysisRequest request,
              Class<T> responseType)

Performs an analysis of the content included in the request getting as response an instance of the Class passed by parameter. Current implementation supports

• String
• InputStream - make sure to close the stream after reading the contents from the response
• Enhancements

If Enhancements is passed, the request will assume RDF+XML as response format, and will parse the response to create the Enhancements object. If String is passed as response type, the method will return the RAW response in the format specified at the AnalysisRequest request parameter

Parameters:

request - AnalysisRequest containing the request parameters and the content to be enhanced

responseType - Class of the response. Only Enhancements and String are supported

Returns:

An instance of the class passed by parameter wrapping the Analysis Service response