Document (JET: Java Extractiop Toolkit 1.9.0 API)

java.lang.Object
- edu.nyu.jet.tipster.Document

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExternalDocument
```
public class Document
extends Object
implements Serializable
```
Document provides a container for the text of a document and the annotations on a document.
Hypotheses: Each annotation on a document can be associated with a hypothesis. If currentHypothesis (set by setCurrentHypothesis(java.lang.Object)) is non-null, each annotation added to the document is given a feature hypo with that value. If activeHypotheses (set by setActiveHypotheses(java.util.Set)) is non-null, methods which return annotations only return those annotations whose hypo feature is among the activeHypotheses.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

SyntacticRelationSet relations

Fields
Modifier and Type	Field and Description
`SyntacticRelationSet`	`relations`

Constructor Summary

Constructors
Constructor and Description
`Document()` Creates a new document with no text or annotations.
`Document(Document doc)`
`Document(String stg)` Creates a new document with text stg and no annotations.

Method Summary

Methods
Modifier and Type	Method and Description
`Annotation`	`addAnnotation(Annotation ann)` Adds an annotation to the document.
`Annotation`	`annotate(String tp, Span sp, FeatureSet att)` Creates an annotation and adds it to the document.
`void`	`annotateWithTag(String tag)` annotateWithTag annotates document with `Span` of text between <tag> and </tag>.
`void`	`annotateWithTag(String tag, int start, int end)` annotateWithTag annotates document with `Span` of text between <tag> and </tag>.
`Vector<Annotation>`	`annotationsAt(int start)` Returns the annotations beginning at character position start.
`Vector<Annotation>`	`annotationsAt(int start, String type)` Returns the annotations of type type beginning at character position start.
`Vector<Annotation>`	`annotationsAt(int start, String[] types)` Returns the annotations which begin at character position start and whose type is in array types.
`Vector<Annotation>`	`annotationsEndingAt(int end)` Returns the annotations ending at character position ending.
`Vector<Annotation>`	`annotationsEndingAt(int end, String type)` Returns the annotations of type type ending at character position end.
`Vector<Annotation>`	`annotationsOfType(String type)` Returns a vector of all annotations of type type.
`Vector<Annotation>`	`annotationsOfType(String type, Span span)` Returns a vector of all annotations of type type whose span is contained within span.
`StringBuffer`	`append(char c)` Adds the char c to the end of the document.
`StringBuffer`	`append(String stg)` Adds the text stg to the end of the document.
`char`	`charAt(int posn)` Returns the character at position posn in the document.
`void`	`clear()` Deletes the text and all annotations on a document, creating an empty document.
`void`	`clearAnnotations()` Removes all annotations on the document.
`Span`	`fullSpan()` Returns a Span covering the entire document.
`String[]`	`getAnnotationTypes()` Returns a vector of all annotation types.
`int`	`getNextAnnotationId()` returns a unique integer for this Document, to be used in assigning an 'id' feature to an Annotation on this Document.
`int`	`length()` Returns the length of the document (in characters).
`String`	`normalizedText(Annotation ann)` Returns the text subsumed by annotation ann, with leading and trailing whitespace removed, and other whitespace sequences replaced by a single blank.
`String`	`normalizedText(Span s)` Returns the text subsumed by span s, with leading and trailing whitespace removed, and other whitespace sequences replaced by a single blank.
`void`	`removeAnnotation(Annotation ann)` Removes annotation ann from the document.
`void`	`removeAnnotationsOfType(String type)` removes all annotations of type 'type' from the document.
`void`	`setActiveHypotheses(Set hypoIdSet)` sets the value of `activeHypotheses`.
`void`	`setCharAt(int posn, char c)` Sets the character at position posn to c.
`void`	`setCurrentHypothesis(Object hypoId)` sets the value of `currentHypothesis`.
`void`	`setSGMLindent(int n)` set amount to indent sgml tags, per level of tag nesting, for writeSGML.
`void`	`setSGMLwrapMargin(int n)` set right margin for wrapping (inserting newlines) into sgml tags.
`void`	`setText(String stg)` Sets the text of a document.
`void`	`shrink(Annotation ann)` shrink the endpoint of Annotation `code` to remove any trailing whitespace.
`void`	`shrink(String type)` shrink the endpoint, using `shrink`, of all annotations of type `type`, to eliminate trailing whitespace.
`void`	`shrinkAll()` shrink the endpoint, using `shrink`, of all annotations in the document.
`void`	`stretch(Annotation ann)` extend the endpoint of Annotation ann to include the following whitespace past the current endpoint.
`void`	`stretch(String type)` extend the endpoint, using `stretch`, of all annotations of type `type`.
`void`	`stretchAll()` extend the endpoint, using `stretch`, of all annotations in the document.
`String`	`text()` Returns the entire text of the document.
`String`	`text(Annotation ann)` Returns the text subsumed by annotation ann.
`String`	`text(Span s)` Returns the text subsumed by span s.
`Annotation`	`tokenAt(int start)` Returns the token annotation starting at position start, or null if no token starts at this position.
`Annotation`	`tokenEndingAt(int end)` Returns the token annotation ending at position end, or null if no token starts at this position.
`StringBuffer`	`writeSGML(String type)` Returns the text of the document with each instance of an annotation of type type enclosed in SGML tags.
`StringBuffer`	`writeSGML(String[] types, int start, int end)` performs writeSGML for characters 'start' through 'end' of the Document, generating tags for annotations whose type appears in array 'types'.
`StringBuffer`	`writeSGML(String type, Span span)` performs writeSGML over portion 'span' of the Document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - relations
```
public SyntacticRelationSet relations
```
- Constructor Detail
  - Document
```
public Document()
```
    Creates a new document with no text or annotations.
  - Document
```
public Document(String stg)
```
    Creates a new document with text stg and no annotations.
  - Document
```
public Document(Document doc)
```
- Method Detail
  - clear
```
public void clear()
```
    Deletes the text and all annotations on a document, creating an empty document.
  - setText
```
public void setText(String stg)
```
    Sets the text of a document. Warning: this should not be done if the document has annotations.
  - text
```
public String text()
```
    Returns the entire text of the document.
  - text
```
public String text(Span s)
```
    Returns the text subsumed by span s.
  - text
```
public String text(Annotation ann)
```
    Returns the text subsumed by annotation ann.
  - normalizedText
```
public String normalizedText(Span s)
```
    Returns the text subsumed by span s, with leading and trailing whitespace removed, and other whitespace sequences replaced by a single blank.
  - normalizedText
```
public String normalizedText(Annotation ann)
```
    Returns the text subsumed by annotation ann, with leading and trailing whitespace removed, and other whitespace sequences replaced by a single blank.
  - append
```
public StringBuffer append(String stg)
```
    Adds the text stg to the end of the document.
  - append
```
public StringBuffer append(char c)
```
    Adds the char c to the end of the document.
  - length
```
public int length()
```
    Returns the length of the document (in characters).
  - fullSpan
```
public Span fullSpan()
```
    Returns a Span covering the entire document.
  - charAt
```
public char charAt(int posn)
```
    Returns the character at position posn in the document.
  - setCharAt
```
public void setCharAt(int posn,
             char c)
```
    Sets the character at position posn to c.
  - clearAnnotations
```
public void clearAnnotations()
```
    Removes all annotations on the document.
  - addAnnotation
```
public Annotation addAnnotation(Annotation ann)
```
    Adds an annotation to the document.
  - annotate
```
public Annotation annotate(String tp,
                  Span sp,
                  FeatureSet att)
```
    Creates an annotation and adds it to the document.
  - removeAnnotation
```
public void removeAnnotation(Annotation ann)
```
    Removes annotation ann from the document. Does nothing if ann is not an annotation on the document.
  - removeAnnotationsOfType
```
public void removeAnnotationsOfType(String type)
```
    removes all annotations of type 'type' from the document.
  - annotationsAt
```
public Vector<Annotation> annotationsAt(int start)
```
    Returns the annotations beginning at character position start. Returns null if there are no annotations starting at this position.
  - annotationsAt
```
public Vector<Annotation> annotationsAt(int start,
                               String type)
```
    Returns the annotations of type type beginning at character position start. If there are no annotations of this type, returns null.
  - annotationsAt
```
public Vector<Annotation> annotationsAt(int start,
                               String[] types)
```
    Returns the annotations which begin at character position start and whose type is in array types. If there are no such annotations, returns null.
  - annotationsEndingAt
```
public Vector<Annotation> annotationsEndingAt(int end)
```
    Returns the annotations ending at character position ending. Returns null if there are no annotations ending at this position.
  - annotationsEndingAt
```
public Vector<Annotation> annotationsEndingAt(int end,
                                     String type)
```
    Returns the annotations of type type ending at character position end. If there are no annotations of this type, returns null.
  - tokenAt
```
public Annotation tokenAt(int start)
```
    Returns the token annotation starting at position start, or null if no token starts at this position.
  - tokenEndingAt
```
public Annotation tokenEndingAt(int end)
```
    Returns the token annotation ending at position end, or null if no token starts at this position.
  - annotationsOfType
```
public Vector<Annotation> annotationsOfType(String type)
```
    Returns a vector of all annotations of type type. Returns null if there are no annotations of this type.
  - annotationsOfType
```
public Vector<Annotation> annotationsOfType(String type,
                                   Span span)
```
    Returns a vector of all annotations of type type whose span is contained within span. If span is null, all annotations of that type are returned. Returns null if there are no annotations starting at this position.
  - setCurrentHypothesis
```
public void setCurrentHypothesis(Object hypoId)
```
    sets the value of currentHypothesis. If currentHypothesis is non-null, a hypo feature with this value is added to every new annotation on this document.
  - setActiveHypotheses
```
public void setActiveHypotheses(Set hypoIdSet)
```
    sets the value of activeHypotheses. If activeHypotheses is non-null, methods which retrieve annotations on a document only return those annotations whose hypo value is in activeHypotheses.
  - getAnnotationTypes
```
public String[] getAnnotationTypes()
```
    Returns a vector of all annotation types. Returns null if there are no annotation types. Warning: do not modify the returned vector. Doing so can affect the annotations stored on a document.
  - annotateWithTag
```
public void annotateWithTag(String tag,
                   int start,
                   int end)
```
    annotateWithTag annotates document with Span of text between <tag> and </tag>. Sets type of annotation to tag name.
    
    Parameters:
    tag - name of a tag to find a Span between tags
    start - where to start searching for a tag
    end - where to end searching for a tag
  - annotateWithTag
```
public void annotateWithTag(String tag)
```
    annotateWithTag annotates document with Span of text between <tag> and </tag>. Sets type of annotation to tag name.
    
    Parameters:
    tag - name of a tag to find a Span between tags
  - getNextAnnotationId
```
public int getNextAnnotationId()
```
    returns a unique integer for this Document, to be used in assigning an 'id' feature to an Annotation on this Document.
  - setSGMLwrapMargin
```
public void setSGMLwrapMargin(int n)
```
    set right margin for wrapping (inserting newlines) into sgml tags. for writeSGML. = 0 if no wrapping. Initial value = 80.
  - setSGMLindent
```
public void setSGMLindent(int n)
```
    set amount to indent sgml tags, per level of tag nesting, for writeSGML. = 0 if no indentation.
  - writeSGML
```
public StringBuffer writeSGML(String type)
```
    Returns the text of the document with each instance of an annotation of type type enclosed in SGML tags. If type == null, all annotations are included.
    A Jet Document may contain annotations that are not nested, but these cannot be represented in SGML or XML. If the endpoint of an annotation is greated than the endpoint of a preceding annotation that is still open, the annotation is not written out.
  - writeSGML
```
public StringBuffer writeSGML(String type,
                     Span span)
```
    performs writeSGML over portion 'span' of the Document.
  - writeSGML
```
public StringBuffer writeSGML(String[] types,
                     int start,
                     int end)
```
    performs writeSGML for characters 'start' through 'end' of the Document, generating tags for annotations whose type appears in array 'types'.
  - stretch
```
public void stretch(Annotation ann)
```
    extend the endpoint of Annotation ann to include the following whitespace past the current endpoint. However, do not extent the endpoint past the current starting point of any other annotation in order to avoid situations where annotations overlap but are not nested.
  - stretch
```
public void stretch(String type)
```
    extend the endpoint, using stretch, of all annotations of type type.
  - stretchAll
```
public void stretchAll()
```
    extend the endpoint, using stretch, of all annotations in the document.
  - shrink
```
public void shrink(Annotation ann)
```
    shrink the endpoint of Annotation code to remove any trailing whitespace.
  - shrink
```
public void shrink(String type)
```
    shrink the endpoint, using shrink, of all annotations of type type, to eliminate trailing whitespace.
  - shrinkAll
```
public void shrinkAll()
```
    shrink the endpoint, using shrink, of all annotations in the document.

Class Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

relations

Constructor Detail

Document

Document

Document

Method Detail

clear

setText

text

text

text

normalizedText

normalizedText

append

append

length

fullSpan

charAt

setCharAt

clearAnnotations

addAnnotation

annotate

removeAnnotation

removeAnnotationsOfType

annotationsAt

annotationsAt

annotationsAt

annotationsEndingAt

annotationsEndingAt

tokenAt

tokenEndingAt

annotationsOfType

annotationsOfType

setCurrentHypothesis

setActiveHypotheses

getAnnotationTypes

annotateWithTag

annotateWithTag

getNextAnnotationId

setSGMLwrapMargin

setSGMLindent

writeSGML

writeSGML

writeSGML

stretch

stretch

stretchAll

shrink

shrink

shrinkAll