io.redlink.sdk.impl.analysis.model

Class TextAnnotation

java.lang.Object

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

io.redlink.sdk.impl.analysis.model.TextAnnotation

All Implemented Interfaces:

Comparable<Enhancement>

public final class TextAnnotation
extends Enhancement

Text annotation, selects pieces of parsed textual content by using the following properties

Author:

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

See Also:

FISE Text Annotation

Constructor Summary

Constructors

Constructor and Description
TextAnnotation()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getEnds() Returns the position of the text where the annotation ends
String	getLanguage() Deprecated. use getSelectedTextLang()
String	getSelectedText() Returns the matched/extracted piece of text from the analyzed content
String	getSelectedTextLang()
String	getSelectionContext() Returns a surrounding context of the matched text
String	getSelectionPrefix() Some chars before the getSelectedText() aimed to allow the location of the selection in case getStarts() and getEnds() can not be used (e.g.
String	getSelectionSuffix() Some chars after the getSelectedText() aimed to allow the location of the selection in case getStarts() and getEnds() can not be used (e.g.
int	getStarts() Returns the position of the text where the annotation starts
String	getType() Returns the type of the entity annotation
int	hashCode()

Methods inherited from class io.redlink.sdk.impl.analysis.model.Enhancement

compareTo, getConfidence, getRelations

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextAnnotation

public TextAnnotation()

Method Detail

getStarts

public int getStarts()

Returns the position of the text where the annotation starts

Returns:

getEnds

public int getEnds()

Returns the position of the text where the annotation ends

Returns:

getSelectedText

public String getSelectedText()

Returns the matched/extracted piece of text from the analyzed content

Returns:

getSelectedTextLang

public String getSelectedTextLang()

getLanguage

@Deprecated
public String getLanguage()

Deprecated. use getSelectedTextLang()

Description copied from class: Enhancement

Enhancements do not have a language.

Overrides:

getLanguage in class Enhancement

Returns:

null

getSelectionContext

public String getSelectionContext()

Returns a surrounding context of the matched text

Returns:

getSelectionPrefix

public String getSelectionPrefix()

Some chars before the getSelectedText() aimed to allow the location of the selection in case getStarts() and getEnds() can not be used (e.g. for rich text documents)

Returns:

the selection prefix

getSelectionSuffix

public String getSelectionSuffix()

Some chars after the getSelectedText() aimed to allow the location of the selection in case getStarts() and getEnds() can not be used (e.g. for rich text documents)

Returns:

the selection prefix

getType

public String getType()

Returns the type of the entity annotation

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object