edu.nyu.jet.tipster

Class Annotation

java.lang.Object

edu.nyu.jet.tipster.Annotation

public class Annotation
extends Object

An Annotation assigns a type and a set of features to a portion of a Document.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ANNOTATION_DEPTH in converting an Annotation to a String, the maximum level of nesting of Annotations which will be printed.

Constructor Summary

Constructors

Constructor and Description
Annotation(String tp, Span sp, FeatureSet att)

Method Summary

Methods

Modifier and Type	Method and Description
void	assignId() if the Annotation does not already have an 'id' feature, assigns an 'id' feature whose value is the unique (to the Document) identifier obtained by Document.getNextAnnotationId().
FeatureSet	attributes()
int	end() returns the end of the span associated with the annotation.
Object	get(String feature) Returns the value of attribute feature of the annotation.
int	getId() returns the value of the 'id' feature (converted from an Integer or String to an int).
void	prepareToMakeString(int nestingLimit) add 'id' feature to all Annotations referenced by this Annotation.
void	put(String feature, Object value) Sets the value of attribute feature of the annotation to value.
void	remove(String feature)
static void	sort(Vector annotations) sorts a Vector of Annotations based on the end of the span of each Annotation, highest end value first.
static void	sortByStartPosition(List<Annotation> annotations) sorts a list of annotation order by its start position.
Span	span() returns the span (of text) associated with the annotation.
int	start() returns the start of the span associated with the annotation.
String	toSGMLString()
String	toSGMLString(int nestingLimit, boolean useIds, boolean quoteValues) returns a String representation of the Annotation, without information about the span of the annotation.
String	toString() returns a String representation of the Annotation, including the type, span, and attributes, enclosed in '<' and '>'.
String	type()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_ANNOTATION_DEPTH

public static final int MAX_ANNOTATION_DEPTH

in converting an Annotation to a String, the maximum level of nesting of Annotations which will be printed. Nesting occurs when the value of some attribute of an Annotation is itself an Annotation. When the maximum level is reached, the reference to the Annotation is represented by '#id'.

See Also:

Constant Field Values

Constructor Detail

Annotation

public Annotation(String tp,
          Span sp,
          FeatureSet att)

Method Detail

type

public String type()

span

public Span span()

returns the span (of text) associated with the annotation.

start

public int start()

returns the start of the span associated with the annotation.

end

public int end()

returns the end of the span associated with the annotation.

attributes

public FeatureSet attributes()

get

public Object get(String feature)

Returns the value of attribute feature of the annotation.

put

public void put(String feature,
       Object value)

Sets the value of attribute feature of the annotation to value.

remove

public void remove(String feature)

assignId

public void assignId()

if the Annotation does not already have an 'id' feature, assigns an 'id' feature whose value is the unique (to the Document) identifier obtained by Document.getNextAnnotationId().

getId

public int getId()

returns the value of the 'id' feature (converted from an Integer or String to an int). Prints a message if the Annotation does not have an 'id' feature, or if the feature is not of the proper type.

prepareToMakeString

public void prepareToMakeString(int nestingLimit)

add 'id' feature to all Annotations referenced by this Annotation. This is invoked prior to converting this Annotation to a String, if annotation references are to be converted to '#nnn' form.

toString

public String toString()

returns a String representation of the Annotation, including the type, span, and attributes, enclosed in '<' and '>'.

Overrides:

toString in class Object

toSGMLString

public String toSGMLString()

toSGMLString

public String toSGMLString(int nestingLimit,
                  boolean useIds,
                  boolean quoteValues)

returns a String representation of the Annotation, without information about the span of the annotation. The representation serves as the open tag in a SGML or XML represenation of the annotated document.

Parameters:

nestingLimit - limit of depth of nested Annotations (Annotations which are referenced as values of features of this Annotation) which will be represented in the String.

useIds - if true, references to Annotations which are nested more deeply than 'nestingLimit' are rendered as '#nnn', where 'nnn' is the 'id' feature of the referenced Annotation; if false, these references are rendered as "..."

quoteValues - if true, values of features are enclosed in double quotes, as required by XML.

sort

public static void sort(Vector annotations)

sorts a Vector of Annotations based on the end of the span of each Annotation, highest end value first. Among annotations with the same end span, if the annotations are linked in a tree structure by 'children' attributes, the highest annotation in the tree is placed first in the sorted sequence.

sortByStartPosition

public static void sortByStartPosition(List<Annotation> annotations)

sorts a list of annotation order by its start position.

Parameters:

annotations -