com.lucidworks.apollo.common.models.nlp

Class AnnotatedText

java.lang.Object

com.lucidworks.apollo.common.models.nlp.AnnotatedText

public class AnnotatedText
extends Object

Container for text and annotations

Constructor Summary

Constructors

Constructor and Description
AnnotatedText(String text)

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(Annotation annotation)
AnnotatedText	detach(Annotation inputAnnotation) Detach text and annotations covered by inputAnnotation into it's own AnnotatedText instance with annotation offsets correctly set relative to detached text
boolean	equals(Object obj)
List<Annotation>	getAnnotationsAsList() Return all annotations in a flat list Annotations of all types are mixed together and no guarantees are given with regards to order.
Map<String,List<Annotation>>	getAnnotationsBetweenCharOffsets(int startTokenOffset, int endTokenOffset, boolean enclosed)
List<Annotation>	getAnnotationsBetweenCharOffsetsByType(int startTokenOffset, int endTokenOffset, String type, boolean enclosed) Get all annotations for given type that are either enclosed or connected to supplied start/end token offsets See https://github.com/google/guava/wiki/RangesExplained#interval-operations for difference between enclosed/connected ranges
List<Annotation>	getAnnotationsByType(String type)
Map<String,List<Annotation>>	getConnectedAnnotations(Annotation annotation) Get all annotations connected to the input annotation's offsets.
Map<String,List<Annotation>>	getCoveredAnnotations(Annotation annotation) Get all annotations covered by the input annotation's offsets For example, pass in a sentence annotation and to retrieve all annotations within that sentence
String	getCoveredText(Annotation annotation)
List<Annotation>	getCoveredTokens(Annotation annotation)
String	getText()
List<Annotation>	getTokens()
List<Annotation>	getTokensBetweenCharOffsets(int startCharOffset, int endCharOffset) Get all tokens that are completely enclosed by start / end character offsets
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedText

public AnnotatedText(String text)

Method Detail

getText

public String getText()

addAnnotation

public void addAnnotation(Annotation annotation)

getTokens

public List<Annotation> getTokens()

getCoveredTokens

public List<Annotation> getCoveredTokens(Annotation annotation)

getCoveredAnnotations

public Map<String,List<Annotation>> getCoveredAnnotations(Annotation annotation)

Get all annotations covered by the input annotation's offsets For example, pass in a sentence annotation and to retrieve all annotations within that sentence

Parameters:

annotation -

Returns:

getConnectedAnnotations

public Map<String,List<Annotation>> getConnectedAnnotations(Annotation annotation)

Get all annotations connected to the input annotation's offsets. For example, pass in a token annotation to retrieve all annotations that include that token.

Parameters:

annotation -

Returns:

getTokensBetweenCharOffsets

public List<Annotation> getTokensBetweenCharOffsets(int startCharOffset,
                                                    int endCharOffset)

Get all tokens that are completely enclosed by start / end character offsets

Parameters:

startCharOffset -

endCharOffset -

Returns:

getAnnotationsBetweenCharOffsets

public Map<String,List<Annotation>> getAnnotationsBetweenCharOffsets(int startTokenOffset,
                                                                     int endTokenOffset,
                                                                     boolean enclosed)

getAnnotationsBetweenCharOffsetsByType

public List<Annotation> getAnnotationsBetweenCharOffsetsByType(int startTokenOffset,
                                                               int endTokenOffset,
                                                               String type,
                                                               boolean enclosed)

Get all annotations for given type that are either enclosed or connected to supplied start/end token offsets See https://github.com/google/guava/wiki/RangesExplained#interval-operations for difference between enclosed/connected ranges

Parameters:

startTokenOffset -

endTokenOffset -

type -

enclosed -

Returns:

getAnnotationsByType

public List<Annotation> getAnnotationsByType(String type)

getCoveredText

public String getCoveredText(Annotation annotation)

detach

public AnnotatedText detach(Annotation inputAnnotation)

Detach text and annotations covered by inputAnnotation into it's own AnnotatedText instance with annotation offsets correctly set relative to detached text

Parameters:

inputAnnotation -

Returns:

getAnnotationsAsList

public List<Annotation> getAnnotationsAsList()

Return all annotations in a flat list Annotations of all types are mixed together and no guarantees are given with regards to order.

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object