io.redlink.sdk.impl.analysis.model

Class Enhancements

java.lang.Object

io.redlink.sdk.impl.analysis.model.Enhancements

All Implemented Interfaces:

Iterable<Enhancement>

public class Enhancements
extends Object
implements Iterable<Enhancement>

Analysis Result API. This class eases the management of the RedLink analysis service results, providing an API that hides the complexity of the Enhancement Structure returned by the service

Author:

sergio.fernandez@redlink.co, rafa.haro@redlink.co

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.collect.Multimap<TextAnnotation,EntityAnnotation>	getBestAnnotations() Returns the best EntityAnnotations (those with the highest confidence value) for each extracted TextAnnotation
Collection<TopicAnnotation>	getCategories() Returns the Collection of extracted categories (topics) for the analyzed content
Collection<Enhancement>	getEnhancements() Returns the Collection of all Enhancements, including Text, Entity and Topic annotations
Collection<Entity>	getEntities() Returns the Collection of dereferenced Entitys
Collection<Entity>	getEntitiesByConfidenceValue(Double confidenceValue) Returns a Collection of Entitys for which associated EntityAnnotations has a confidence value greater than or equal to the value passed by parameter
Entity	getEntity(String URI) Returns a dereferenced entity by its URI
EntityAnnotation	getEntityAnnotation(String entityUri) Returns an EntityAnnotation by its associated dereferenced Entity URI
Collection<EntityAnnotation>	getEntityAnnotations() Returns the Collection of extracted EntityAnnotations
Collection<EntityAnnotation>	getEntityAnnotations(TextAnnotation ta) Returns a Collection of EntityAnnotations associated to the TextAnnotation passed by parameter
Collection<EntityAnnotation>	getEntityAnnotationsByConfidenceValue(Double confidenceValue) Returns a Collection of EntityAnnotations which confidences values are greater than or equal to the value passed by parameter
com.google.common.collect.Multimap<TextAnnotation,EntityAnnotation>	getEntityAnnotationsByTextAnnotation()
Collection<String>	getLanguages() Returns a Collection of identified languages in the analyzed content
Collection<TextAnnotation>	getTextAnnotations() Returns the Collection of extracted TextAnnotations
Collection<TextAnnotation>	getTextAnnotationsByConfidenceValue(Double confidenceValue) Returns a Collection of TextAnnotations which confidences values are greater than or equal to the value passed by parameter
boolean	hasCategory(String conceptURI) Returns true if the contents has been categorized with a category identified by the URI passed by parameter
Iterator<Enhancement>	iterator()

Methods inherited from class java.lang.Object

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

Method Detail

iterator

public Iterator<Enhancement> iterator()

Specified by:

iterator in interface Iterable<Enhancement>

getEnhancements

public Collection<Enhancement> getEnhancements()

Returns the Collection of all Enhancements, including Text, Entity and Topic annotations

Returns:

getTextAnnotations

public Collection<TextAnnotation> getTextAnnotations()

Returns the Collection of extracted TextAnnotations

Returns:

getEntityAnnotations

public Collection<EntityAnnotation> getEntityAnnotations()

Returns the Collection of extracted EntityAnnotations

Returns:

getEntities

public Collection<Entity> getEntities()

Returns the Collection of dereferenced Entitys

Returns:

getEntity

public Entity getEntity(String URI)

Returns a dereferenced entity by its URI

Parameters:

URI -

Returns:

getEntityAnnotations

public Collection<EntityAnnotation> getEntityAnnotations(TextAnnotation ta)

Returns a Collection of EntityAnnotations associated to the TextAnnotation passed by parameter

Parameters:

ta - TextAnnotation

Returns:

getEntitiesByConfidenceValue

public Collection<Entity> getEntitiesByConfidenceValue(Double confidenceValue)

Returns a Collection of Entitys for which associated EntityAnnotations has a confidence value greater than or equal to the value passed by parameter

Parameters:

confidenceValue - Threshold confidence value

Returns:

getTextAnnotationsByConfidenceValue

public Collection<TextAnnotation> getTextAnnotationsByConfidenceValue(Double confidenceValue)

Returns a Collection of TextAnnotations which confidences values are greater than or equal to the value passed by parameter

Parameters:

confidenceValue - Threshold confidence value

Returns:

getEntityAnnotationsByConfidenceValue

public Collection<EntityAnnotation> getEntityAnnotationsByConfidenceValue(Double confidenceValue)

Returns a Collection of EntityAnnotations which confidences values are greater than or equal to the value passed by parameter

Parameters:

confidenceValue - Threshold confidence value

Returns:

getEntityAnnotationsByTextAnnotation

public com.google.common.collect.Multimap<TextAnnotation,EntityAnnotation> getEntityAnnotationsByTextAnnotation()

getBestAnnotations

public com.google.common.collect.Multimap<TextAnnotation,EntityAnnotation> getBestAnnotations()

Returns the best EntityAnnotations (those with the highest confidence value) for each extracted TextAnnotation

Returns:

best annotations

getEntityAnnotation

public EntityAnnotation getEntityAnnotation(String entityUri)

Returns an EntityAnnotation by its associated dereferenced Entity URI

Parameters:

entityUri -

Returns:

getLanguages

public Collection<String> getLanguages()

Returns a Collection of identified languages in the analyzed content

Returns:

getCategories

public Collection<TopicAnnotation> getCategories()

Returns the Collection of extracted categories (topics) for the analyzed content

Returns:

hasCategory

public boolean hasCategory(String conceptURI)

Returns true if the contents has been categorized with a category identified by the URI passed by parameter

Parameters:

conceptURI - URI of the category concept

Returns: