edu.nyu.jet.tipster

Class ExternalDocument

java.lang.Object

edu.nyu.jet.tipster.Document

edu.nyu.jet.tipster.ExternalDocument

All Implemented Interfaces:

Serializable

public class ExternalDocument
extends Document

a Document associated with a file. The document may either by closed (information resides only on the file) or open (information resides on file and in object in memory).

See Also:

Serialized Form

Field Summary

Fields inherited from class edu.nyu.jet.tipster.Document

relations

Constructor Summary

Constructors

Constructor and Description
ExternalDocument(String format, String fileName) creates a new external document associated with file 'fileName'.
ExternalDocument(String format, String directory, String fileName)

Method Summary

Methods

Modifier and Type	Method and Description
String	directory() returns the directory associated with the document, or 'null' if there is no directory (if the fileName contains the full path).
String	fileName() returns the file name associated with the document.
String	format() returns the format of the file holding this document: 'sgml' or 'pos'.
String	fullFileName() the full file name, including both the directory and the file name within the directory
boolean	isOpen() returns 'true' if the file has been opened.
boolean	open() opens the externalDocument: reads the contents of the file, filling the text and annotations of the document.
void	save() saves the Document to the directory/fileName used for opening the Document.
void	saveAs(String directory, String fileName) saves the Document to file 'fileName' in directory 'directory'.
void	saveIn(String directory) saves the Document to the originally specified fileName in directory 'directory'.
void	setAllTags(boolean allTags) if allTags == true, specifies that all SGML tags are to be converted to annotations when this document is opened.
void	setEmptyTags(String[] tags) specify a list of empty tags -- tags which do not have any corresponding close tags and so should be converted to empty Annotations.
void	setSGMLtags(String[] tags) sets the list of SGML tags which are to be converted to annotations when this document is opened.
static void	writeWithSystemNewlines(BufferedWriter writer, String string) writes string to writer, converting newline characters to system-specific newlines.

Methods inherited from class edu.nyu.jet.tipster.Document

addAnnotation, annotate, annotateWithTag, annotateWithTag, annotationsAt, annotationsAt, annotationsAt, annotationsEndingAt, annotationsEndingAt, annotationsOfType, annotationsOfType, append, append, charAt, clear, clearAnnotations, fullSpan, getAnnotationTypes, getNextAnnotationId, length, normalizedText, normalizedText, removeAnnotation, removeAnnotationsOfType, setActiveHypotheses, setCharAt, setCurrentHypothesis, setSGMLindent, setSGMLwrapMargin, setText, shrink, shrink, shrinkAll, stretch, stretch, stretchAll, text, text, text, tokenAt, tokenEndingAt, writeSGML, writeSGML, writeSGML

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalDocument

public ExternalDocument(String format,
                String fileName)

creates a new external document associated with file 'fileName'. The format of the file is given by 'format'. At present on the format 'sgml' (a file with SGML markup which is to be converted to annotations) is recognized.

ExternalDocument

public ExternalDocument(String format,
                String directory,
                String fileName)

Method Detail

setSGMLtags

public void setSGMLtags(String[] tags)

sets the list of SGML tags which are to be converted to annotations when this document is opened. Applicable only to documents of format 'sgml'.

setAllTags

public void setAllTags(boolean allTags)

if allTags == true, specifies that all SGML tags are to be converted to annotations when this document is opened. Applicable only to documents of format 'sgml'.

setEmptyTags

public void setEmptyTags(String[] tags)

specify a list of empty tags -- tags which do not have any corresponding close tags and so should be converted to empty Annotations.

open

public boolean open()

opens the externalDocument: reads the contents of the file, filling the text and annotations of the document. Returns true if the Document was successfully opened, or was already open; returns false if there was an error in opening the file.

save

public void save()

saves the Document to the directory/fileName used for opening the Document. The document must be open.

writeWithSystemNewlines

public static void writeWithSystemNewlines(BufferedWriter writer,
                           String string)
                                    throws IOException

writes string to writer, converting newline characters to system-specific newlines.

Throws:

IOException

saveIn

public void saveIn(String directory)

saves the Document to the originally specified fileName in directory 'directory'.

saveAs

public void saveAs(String directory,
          String fileName)

saves the Document to file 'fileName' in directory 'directory'.

isOpen

public boolean isOpen()

returns 'true' if the file has been opened.

format

public String format()

returns the format of the file holding this document: 'sgml' or 'pos'.

directory

public String directory()

returns the directory associated with the document, or 'null' if there is no directory (if the fileName contains the full path).

fileName

public String fileName()

returns the file name associated with the document.

fullFileName

public String fullFileName()

the full file name, including both the directory and the file name within the directory