edu.nrao.sss.model.source.parser
Class PstSourceCatalogWriter

java.lang.Object
  edu.nrao.sss.model.source.parser.AbstractSourceCatalogWriter
      edu.nrao.sss.model.source.parser.PstSourceCatalogWriter

All Implemented Interfaces:

SourceCatalogWriter

public class PstSourceCatalogWriter
extends AbstractSourceCatalogWriter

A writer of source catalog text files in the format used by the GBT / VLA Proposal Submission Tool (PST). See PstSourceCatalogReader for details about this format.

Version Info:

$Revision$

$Date$

$Author$ (last person to modify)

Since:

2007-08-10

Author:

David M. Harland

Field Summary

Fields inherited from class edu.nrao.sss.model.source.parser.AbstractSourceCatalogWriter

errors, writeWasSuccessful

Constructor Summary

PstSourceCatalogWriter()

Method Summary

boolean

write(SourceCatalog catalog, Writer out) Must be overridden to perform the actual writing.

Methods inherited from class edu.nrao.sss.model.source.parser.AbstractSourceCatalogWriter

getError, getErrorCount, getErrors, getSuccess, putError, putError, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

PstSourceCatalogWriter

public PstSourceCatalogWriter()

Method Detail

write

public boolean write(SourceCatalog catalog,
                     Writer out)

Must be overridden to perform the actual writing. All other write methods delegate to this one.

Note that this method closes the writer when it is done.

Specified by:

write in interface SourceCatalogWriter

Specified by:

write in class AbstractSourceCatalogWriter

Parameters:

catalog - the catalog of sources to output

out - the destination of the text representation.

Returns:

true if nothing unexpected occurred while reading data.

See Also:

SourceCatalogWriter.write(SourceCatalog, Writer)