de.datexis.ner

Class MentionAnnotation

java.lang.Object

de.datexis.model.Span

de.datexis.model.Annotation

de.datexis.ner.MentionAnnotation

All Implemented Interfaces:

Comparable<Span>

public class MentionAnnotation
extends Annotation

Annotation of a named entity mention.

Author:

sarnold, fgrimme

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MentionAnnotation.Type

Nested classes/interfaces inherited from class de.datexis.model.Annotation

Annotation.Match, Annotation.Source

Field Summary

Fields

Modifier and Type	Field and Description
protected String	refId Referenced ID, e.g.
protected String	type Type of the annotation, e.g.

Fields inherited from class de.datexis.model.Annotation

confidence, source, text

Fields inherited from class de.datexis.model.Span

begin, end, uid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MentionAnnotation() Deprecated. only used for JSON deserialization.
	MentionAnnotation(Annotation.Source source, int begin, int end, String type, List<Token> tokens) Creates a Typed MentionAnnotation using manual Span offsets.
	MentionAnnotation(Annotation.Source source, List<Token> tokens) Creates a GENERIC MentionAnnotation using Span offsets from given Tokens.
	MentionAnnotation(Annotation.Source source, List<Token> tokens, double confidence) Creates a GENERIC MentionAnnotation using Span offsets from given Tokens.
	MentionAnnotation(Annotation.Source source, String text, int begin, int end) Creates a GENERIC MentionAnnotation using manual Text and Span offsets.
	MentionAnnotation(Document doc, Annotation.Source source, List<Token> tokens, String type, double confidence) Creates a GENERIC MentionAnnotation using Span offsets from given Tokens.

Method Summary

Modifier and Type	Method and Description
static void	annotateFromTags(AbstractIterator it, Annotation.Source source, Class<? extends Tag> tagset)
static void	annotateFromTags(AbstractIterator it, Annotation.Source source, Class<? extends Tag> tagset, String type)
static void	annotateFromTags(Document doc, Annotation.Source source, Class<? extends Tag> tagset)
static void	annotateFromTags(Document doc, Annotation.Source source, Class<? extends Tag> tagset, String type)
static void	annotateFromTags(Iterable<Document> docs, Annotation.Source source, Class<? extends Tag> tagset)
static void	annotateFromTags(Iterable<Document> docs, Annotation.Source source, Class<? extends Tag> tagset, String type)
static MentionAnnotation	createFromPositions(Annotation.Source source, Document doc, int begin, int end, String id, String type)
static void	createTagsFromAnnotations(Document doc, Annotation.Source source, Class<? extends Tag> tagset)
boolean	equals(Object obj)
String	getRefId()
String	getType()
int	hashCode()
void	setRefId(String id)
void	setType(String type) Set the type of the Annotation
String	toString()

Methods inherited from class de.datexis.model.Annotation

contains, getConfidence, getSource, getText, intersects, matches, matches, setConfidence, setSource, setText

Methods inherited from class de.datexis.model.Span

clearTags, clearVectors, clearVectors, clearVectors, compareTo, getBegin, getDocumentRef, getDocumentRefUid, getEnd, getLength, getTag, getUid, getVector, getVector, getVector, getVectorKeys, hasVector, hasVector, putTag, putVector, putVector, setBegin, setDocumentRef, setEnd, setLength, setUid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

protected String type

Type of the annotation, e.g. PER, ORG, LOC

refId

protected String refId

Referenced ID, e.g. Wikipedia Page name

Constructor Detail

MentionAnnotation

public MentionAnnotation(Annotation.Source source,
                         int begin,
                         int end,
                         String type,
                         List<Token> tokens)

Creates a Typed MentionAnnotation using manual Span offsets.

MentionAnnotation

public MentionAnnotation(Annotation.Source source,
                         String text,
                         int begin,
                         int end)

Creates a GENERIC MentionAnnotation using manual Text and Span offsets.

MentionAnnotation

public MentionAnnotation(Annotation.Source source,
                         List<Token> tokens)

Creates a GENERIC MentionAnnotation using Span offsets from given Tokens.

MentionAnnotation

public MentionAnnotation(Annotation.Source source,
                         List<Token> tokens,
                         double confidence)

Creates a GENERIC MentionAnnotation using Span offsets from given Tokens.

MentionAnnotation

public MentionAnnotation(Document doc,
                         Annotation.Source source,
                         List<Token> tokens,
                         String type,
                         double confidence)

Creates a GENERIC MentionAnnotation using Span offsets from given Tokens.

MentionAnnotation

@Deprecated
protected MentionAnnotation()

Deprecated. only used for JSON deserialization.

Default constructor.

Method Detail

getType

public String getType()

Returns:

the type of the Annotation e.g. PER, ORG, LOC

setType

public void setType(String type)

Set the type of the Annotation

Parameters:

type -

getRefId

public String getRefId()

Returns:

referenced ID, e.g. Wikipedia Page name

setRefId

public void setRefId(String id)

hashCode

public int hashCode()

Overrides:

hashCode in class Annotation

equals

public boolean equals(Object obj)

Overrides:

equals in class Annotation

toString

public String toString()

Overrides:

toString in class Object

createFromPositions

public static MentionAnnotation createFromPositions(Annotation.Source source,
                                                    Document doc,
                                                    int begin,
                                                    int end,
                                                    String id,
                                                    String type)

annotateFromTags

public static void annotateFromTags(Iterable<Document> docs,
                                    Annotation.Source source,
                                    Class<? extends Tag> tagset)

annotateFromTags

public static void annotateFromTags(Iterable<Document> docs,
                                    Annotation.Source source,
                                    Class<? extends Tag> tagset,
                                    String type)

annotateFromTags

public static void annotateFromTags(AbstractIterator it,
                                    Annotation.Source source,
                                    Class<? extends Tag> tagset)

annotateFromTags

public static void annotateFromTags(AbstractIterator it,
                                    Annotation.Source source,
                                    Class<? extends Tag> tagset,
                                    String type)

annotateFromTags

public static void annotateFromTags(Document doc,
                                    Annotation.Source source,
                                    Class<? extends Tag> tagset)

annotateFromTags

public static void annotateFromTags(Document doc,
                                    Annotation.Source source,
                                    Class<? extends Tag> tagset,
                                    String type)

createTagsFromAnnotations

public static void createTagsFromAnnotations(Document doc,
                                             Annotation.Source source,
                                             Class<? extends Tag> tagset)