io.redlink.sdk.impl.analysis.model

Class EnhancementsParser

java.lang.Object

io.redlink.sdk.impl.analysis.model.EnhancementsParser

public abstract class EnhancementsParser
extends Object

Enhancement Structure (RedLink's analysis service response) Parser API. The Enhancement Structure (https://stanbol.apache.org/docs/trunk/components/enhancer/enhancementstructure) can be serialized in different formats, being RDF the default one. Each implementation of the parser has the mission to read the structure in the incoming format and transform it in a Enhancements object, allowing the user to use the results in an easier way.

Author:

rafa.haro@redlink.co

Constructor Summary

Constructors

Constructor and Description
EnhancementsParser()

Method Summary

Modifier and Type	Method and Description
Enhancements	createEnhancements() Returns an Enhancements object from a serialized Enhancement Structure
abstract Double	parseDocumentSentiment() Returns the Sentiment for the processed document or null if no Sentiment analysis component is configured for the analysis.
abstract Entity	parseEntity(String entityUri, String dataset) Returns a dereferenced Entity identified by its URI from a serialized Enhancement Structure
abstract Collection<EntityAnnotation>	parseEntityAnnotations() Returns a Collection of EntityAnnotations from a serialized Enhancement Structure
abstract Collection<String>	parseLanguages() Returns a Collection of languages from a serialized Enhancement Structure
abstract Collection<SentimentAnnotation>	parseSentimentAnnotation() Returns a Collection of SentimentAnnotations from a serialized Enhancement Structure
abstract Collection<TextAnnotation>	parseTextAnnotations() Returns a Collection of TextAnnotations from a serialized Enhancement Structure
abstract Collection<TopicAnnotation>	parseTopicAnnotation() Returns a Collection of TopicAnnotations from a serialized Enhancement Structure

Methods inherited from class java.lang.Object

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

Constructor Detail

EnhancementsParser

public EnhancementsParser()

Method Detail

createEnhancements

public final Enhancements createEnhancements()
                                      throws EnhancementParserException

Returns an Enhancements object from a serialized Enhancement Structure

Returns:

Throws:

EnhancementParserException

parseLanguages

public abstract Collection<String> parseLanguages()
                                           throws EnhancementParserException

Returns a Collection of languages from a serialized Enhancement Structure

Returns:

Throws:

EnhancementParserException

parseTextAnnotations

public abstract Collection<TextAnnotation> parseTextAnnotations()
                                                         throws EnhancementParserException

Returns a Collection of TextAnnotations from a serialized Enhancement Structure

Returns:

Throws:

EnhancementParserException

parseEntityAnnotations

public abstract Collection<EntityAnnotation> parseEntityAnnotations()
                                                             throws EnhancementParserException

Returns a Collection of EntityAnnotations from a serialized Enhancement Structure

Returns:

Throws:

EnhancementParserException

parseTopicAnnotation

public abstract Collection<TopicAnnotation> parseTopicAnnotation()
                                                          throws EnhancementParserException

Returns a Collection of TopicAnnotations from a serialized Enhancement Structure

Returns:

Throws:

EnhancementParserException

parseSentimentAnnotation

public abstract Collection<SentimentAnnotation> parseSentimentAnnotation()
                                                                  throws EnhancementParserException

Returns a Collection of SentimentAnnotations from a serialized Enhancement Structure

Returns:

Throws:

EnhancementParserException

parseDocumentSentiment

public abstract Double parseDocumentSentiment()
                                       throws EnhancementParserException

Returns the Sentiment for the processed document or null if no Sentiment analysis component is configured for the analysis.

Returns:

the Document Sentiment or null if not available

Throws:

EnhancementParserException

parseEntity

public abstract Entity parseEntity(String entityUri,
                                   String dataset)
                            throws EnhancementParserException

Returns a dereferenced Entity identified by its URI from a serialized Enhancement Structure

Parameters:

entityUri -

Returns:

Throws:

EnhancementParserException