Enhancements (redlink-sdk-java 1.0.6 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.common.collect.Multimap<TextAnnotation,EntityAnnotation>`	`getBestAnnotations()` Returns the best `EntityAnnotation`s (those with the highest confidence value) for each extracted `TextAnnotation`
`Collection<TopicAnnotation>`	`getCategories()` Returns the `Collection` of extracted categories (topics) for the analyzed content
`Double`	`getDocumentSentiment()` Getter for the overall sentiment of the Document
`Collection<Enhancement>`	`getEnhancements()` Returns the `Collection` of all `Enhancement`s, including Text, Entity and Topic annotations
`Collection<Entity>`	`getEntities()` Returns the `Collection` of dereferenced `Entity`s
`Collection<Entity>`	`getEntitiesByConfidenceValue(Double confidenceValue)` Returns a `Collection` of `Entity`s for which associated `EntityAnnotation`s 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 `EntityAnnotation`s
`Collection<EntityAnnotation>`	`getEntityAnnotations(TextAnnotation ta)` Returns a `Collection` of `EntityAnnotation`s associated to the `TextAnnotation` passed by parameter
`Collection<EntityAnnotation>`	`getEntityAnnotationsByConfidenceValue(Double confidenceValue)` Returns a `Collection` of `EntityAnnotation`s which confidences values are greater than or equal to the value passed by parameter
`Collection<EntityAnnotation>`	`getEntityAnnotationsByConfidenceValue(Double minConfidenceValue, Double maxConfidenceValue)` Returns a `Collection` of `EntityAnnotation`s which confidences values are greater than or equal to the value passed by parameter
`com.google.common.collect.Multimap<TextAnnotation,EntityAnnotation>`	`getEntityAnnotationsByTextAnnotation()`
`Collection<KeywordAnnotation>`	`getKeywordAnnotations()` Returns the `Collection` of extracted `EntityAnnotation`s
`Collection<KeywordAnnotation>`	`getKeywordAnnotationsByCountMetric(Integer minCount, Double minMetric)` Returns a `Collection` of `KeywordAnnotation`s which a count greater than or equal the required count metric greater than or equals the required metric y
`Collection<String>`	`getLanguages()` Returns a `Collection` of identified languages in the analyzed content
`Collection<SentimentAnnotation>`	`getSentimentAnnotations()` Returns the `Collection` of extracted `SentimentAnnotation`s.
`Collection<TextAnnotation>`	`getTextAnnotations()` Returns the `Collection` of extracted `TextAnnotation`s
`Collection<TextAnnotation>`	`getTextAnnotationsByConfidenceValue(Double confidenceValue)` Returns a `Collection` of `TextAnnotation`s which confidences values are greater than or equal to the value passed by parameter
`Collection<TopicAnnotation>`	`getTopicAnnotations()` Returns the `Collection` of extracted `EntityAnnotation`s
`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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- 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:
  - getSentimentAnnotations
```
public Collection<SentimentAnnotation> getSentimentAnnotations()
```
    Returns the Collection of extracted SentimentAnnotations. This allows to process low level sentiment values extracted from sub-sections of the document (e.g. on Sentence level). Use getDocumentSentiment() to get the overall sentiment of the document as a whole
    
    Returns:
    
    A collection of Sentiment annotations for sub-sections of the document
    
    See Also:
    
    getDocumentSentiment()
  - getTopicAnnotations
```
public Collection<TopicAnnotation> getTopicAnnotations()
```
    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:
  - getEntityAnnotationsByConfidenceValue
```
public Collection<EntityAnnotation> getEntityAnnotationsByConfidenceValue(Double minConfidenceValue,
                                                                          Double maxConfidenceValue)
```
    Returns a Collection of EntityAnnotations which confidences values are greater than or equal to the value passed by parameter
    
    Parameters:
    
    minConfidenceValue - Minimum threshold confidence value
    
    maxConfidenceValue - Maximum 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:
  - getDocumentSentiment
```
public Double getDocumentSentiment()
```
    Getter for the overall sentiment of the Document
    
    Returns:
    
    the document sentiment or null if no sentiment component is configured for the analysis.
  - 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:
  - getKeywordAnnotations
```
public Collection<KeywordAnnotation> getKeywordAnnotations()
```
    Returns the Collection of extracted EntityAnnotations
    
    Returns:
  - getKeywordAnnotationsByCountMetric
```
public Collection<KeywordAnnotation> getKeywordAnnotationsByCountMetric(Integer minCount,
                                                                        Double minMetric)
```
    Returns a Collection of KeywordAnnotations which a
    - count greater than or equal the required count
    - metric greater than or equals the required metric
    y
    Parameters:
    
    minCount - Threshold count value or null for no threshold
    
    minMetric - Threshold metric value or null for no threshold
    
    Returns:
    
    the KeywordAnnotations fulfilling the parsed requirements.

Class Enhancements

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

iterator

getEnhancements

getTextAnnotations

getEntityAnnotations

getSentimentAnnotations

getTopicAnnotations

getEntities

getEntity

getEntityAnnotations

getEntitiesByConfidenceValue

getTextAnnotationsByConfidenceValue

getEntityAnnotationsByConfidenceValue

getEntityAnnotationsByConfidenceValue

getEntityAnnotationsByTextAnnotation

getBestAnnotations

getEntityAnnotation

getLanguages

getDocumentSentiment

getCategories

hasCategory

getKeywordAnnotations

getKeywordAnnotationsByCountMetric