io.redlink.sdk.impl.analysis.model

Class Enhancement

java.lang.Object

io.redlink.sdk.impl.analysis.model.Enhancement

All Implemented Interfaces:

Comparable<Enhancement>

Direct Known Subclasses:

EntityAnnotation, KeywordAnnotation, SentimentAnnotation, TextAnnotation, TopicAnnotation

public abstract class Enhancement
extends Object
implements Comparable<Enhancement>

RedLink's simplified Analysis' Annotations common schema. For more information, please visit https://stanbol.apache.org/docs/trunk/components/enhancer/enhancementstructure

Author:

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

See Also:

Stanbol's enhancement structure

Constructor Summary

Constructors

Constructor and Description
Enhancement()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Enhancement o)
Double	getConfidence() Get Annotation's confidence value.
String	getLanguage() Deprecated. use {label}Language methods of subclasses. This will always return null (if not overridden by subclasses).
Collection<Enhancement>	getRelations() Returns a Collection of Annotations related to the current one

Methods inherited from class java.lang.Object

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

Constructor Detail

Enhancement

public Enhancement()

Method Detail

getConfidence

public Double getConfidence()

Get Annotation's confidence value. A confidence value will be always in the range [0,1]. For Text annotations, the confidence value provides an estimation about how likely the matched text correspond to some entity in one of the configured datasets for the user RedLink application and will depend of the configured analysis engines. Entity annotations' confidence values provide an estimation about how likely a Text Annotation actually refers to the entity

Returns:

Annotation's confidence value

getRelations

public Collection<Enhancement> getRelations()

Returns a Collection of Annotations related to the current one

Returns:

getLanguage

public String getLanguage()

Deprecated. use {label}Language methods of subclasses. This will always return null (if not overridden by subclasses).

Enhancements do not have a language.

Returns:

null

compareTo

public int compareTo(Enhancement o)

Specified by:

compareTo in interface Comparable<Enhancement>