edu.nyu.jet.tipster

Class DocumentCollection

java.lang.Object

edu.nyu.jet.tipster.DocumentCollection

public class DocumentCollection
extends Object

a set of ExternalDocuments.

The DocumentCollection is represented by a file with one line for each ExternalDocument in the DocumentCollection. The line consist of either

• the file name of the Document (if the Document is in SGML representation)
• the type (external representation) of the Document, a vertical bar (|), and the file name for the Document.

Currently types 'sgml' and 'pos' are supported. If the file name of the Document is a relative path, and the DocumentCollection is created with no explicit directory specified, the path is interpreted as relative to the directory containing the DocumentCollection file.

Constructor Summary

Constructors

Constructor and Description
DocumentCollection(String fileName) create a new DocumentCollection based on file 'fileName'.
DocumentCollection(String directory, String fileName) create a new DocumentCollection based on file fileName, where the paths are relative to directory.

Method Summary

Methods

Modifier and Type	Method and Description
ExternalDocument	get(int i) returns the i-th document in the Collection.
String	getName() returns the fileName (not the full path) of the Collection.
boolean	open() read the information about the Collection from an external file.
void	save() save all the Documents in the Collection.
void	saveAs(String newFileName) save the Collection to file 'newFileName', and then save all the Documents in the Collection.
void	saveAs(String newFileName, String collectionDirectory)
void	saveAsAbsolute(String newFileName, String collectionDirectory)
int	size() returns the number of documents in the Collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentCollection

public DocumentCollection(String fileName)

create a new DocumentCollection based on file 'fileName'.

DocumentCollection

public DocumentCollection(String directory,
                  String fileName)

create a new DocumentCollection based on file fileName, where the paths are relative to directory.

Method Detail

open

public boolean open()

read the information about the Collection from an external file. A DocumentCollection must be opened before other operations can be performed on the collection.

save

public void save()

save all the Documents in the Collection. This assumes that the Collection and all its Documents are open.

saveAs

public void saveAs(String newFileName)

save the Collection to file 'newFileName', and then save all the Documents in the Collection. If the Documents in the Collection are specified by relative file names, the Documents will be saved as new files whose paths are relative to 'newFileName'. This operation assumes that the Collection and all its Documents are open.

saveAs

public void saveAs(String newFileName,
          String collectionDirectory)

Parameters:

parsedCollection -

parseDir -

saveAsAbsolute

public void saveAsAbsolute(String newFileName,
                  String collectionDirectory)

Parameters:

parsedCollection -

parseDir -

size

public int size()

returns the number of documents in the Collection.

get

public ExternalDocument get(int i)

returns the i-th document in the Collection.

getName

public String getName()

returns the fileName (not the full path) of the Collection.