cds.savot.writer
Class SavotWriter

java.lang.Object
  cds.savot.writer.SavotWriter

public class SavotWriter
extends java.lang.Object

VOTable document generation from memory

Version:

2.6 Copyright CDS 2002-2005 6 June 2005 : the user can now write a VOTable document flow step by step, the previous method is avilable too (writing of a whole document) (kickoff 31 May 02)

Author:

Andre Schaaff

Constructor Summary

SavotWriter()

Method Summary

void	enableAttributeEntities(boolean entities) Enable or disable Attribute entities mapping
void	enableElementEntities(boolean entities) Enable or disable Element entities mapping
void	enableEntities(boolean entities) Enable or disable Attribute and Element entities mapping
static java.lang.String	encodeAttribute(java.lang.String src) Encode special characters to entities
static java.lang.String	encodeElement(java.lang.String src) Encode special characters to entities
void	generateDocument(SavotVOTable votable) Generates a VOTable XML document corresponding to the internal model The result is sent to the standard output
void	generateDocument(SavotVOTable votable, java.io.OutputStream stream) Generates a VOTable XML document corresponding to the internal model
void	generateDocument(SavotVOTable votable, java.lang.String file) Generates a VOTable XML document corresponding to the internal model
void	generateDocument(SavotVOTable votable, java.lang.String file, java.io.OutputStream stream) Generates a VOTable XML document corresponding to the internal model
void	initStream(java.io.OutputStream stream) Init the Stream for the output
void	initStream(java.lang.String file) Init the Stream for the output
void	writeBinary(SavotBinary binary) Write a BINARY element
void	writeComment(java.lang.String comment) Write a comment
void	writeCoosys(CoosysSet coosysSet) Write a COOSYS set
void	writeDataBegin() Write a DATA begin
void	writeDataEnd() Write a DATA end
void	writeDescription(java.lang.String description) Generates a VOTable XML document corresponding to the internal model
void	writeDocumentEnd() Write a VOTable XML end
void	writeDocumentHead(SavotVOTable votable) Write a VOTable XML head
void	writeField(FieldSet fieldSet) Write a FIELD set
void	writeFieldRef(FieldRefSet fieldRefSet) Write a FIELD set
void	writeFits(SavotFits fits) Write a FITS element
void	writeGroup(GroupSet groupSet) Write a GROUP set
void	writeInfo(InfoSet infoSet) Write an INFO set
void	writeLink(LinkSet linkSet) Write a LINK set
void	writeMax(SavotMax max) Write a MAX element
void	writeMin(SavotMin min) Write a MIN element
void	writeOption(OptionSet optionSet) Write an OPTION set
void	writeParam(ParamSet params) Write a PARAM set
void	writeParamRef(ParamRefSet refparams) Write a PARAMref set
void	writeResource(ResourceSet resourceset) Write a RESOURCE set
void	writeResourceBegin(SavotResource resource) Write a RESOURCE begin
void	writeResourceEnd() Write a RESOURCE end
void	writeStream(SavotStream stream) Write a STREAM element
void	writeTableBegin(SavotTable table) Write a TABLE begin
void	writeTableDataBegin() Write a TABLEDATA begin
void	writeTableDataEnd() Write a TABLEDATA end
void	writeTableEnd() Write a TABLE end
void	writeTR(SavotTR tr) Write a TR
void	writeValues(SavotValues values) Write a VALUES element

Methods inherited from class java.lang.Object

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

Constructor Detail

SavotWriter

public SavotWriter()

Method Detail

enableAttributeEntities

public void enableAttributeEntities(boolean entities)

Enable or disable Attribute entities mapping

Parameters:

entities - true if Attribute entities are taken into account

enableElementEntities

public void enableElementEntities(boolean entities)

Enable or disable Element entities mapping

Parameters:

entities - true if Element entities are taken into account

enableEntities

public void enableEntities(boolean entities)

Enable or disable Attribute and Element entities mapping

Parameters:

entities - true if all entities are taken into account

encodeAttribute

public static java.lang.String encodeAttribute(java.lang.String src)

Encode special characters to entities

Parameters:

src -

Returns:

src

encodeElement

public static java.lang.String encodeElement(java.lang.String src)

Encode special characters to entities

Parameters:

src -

Returns:

src

generateDocument

public void generateDocument(SavotVOTable votable)

Generates a VOTable XML document corresponding to the internal model The result is sent to the standard output

Parameters:

votable - object corresponding to the savot internal model

generateDocument

public void generateDocument(SavotVOTable votable,
                             java.io.OutputStream stream)

Generates a VOTable XML document corresponding to the internal model

Parameters:

votable - object corresponding to the savot internal model

stream - the result is sent to this stream

generateDocument

public void generateDocument(SavotVOTable votable,
                             java.lang.String file)

Generates a VOTable XML document corresponding to the internal model

Parameters:

votable - object corresponding to the savot internal model

file - is sent to this file

generateDocument

public void generateDocument(SavotVOTable votable,
                             java.lang.String file,
                             java.io.OutputStream stream)

Generates a VOTable XML document corresponding to the internal model

Parameters:

votable - SavotVOTable

file - String

stream - OutputStream

writeDescription

public void writeDescription(java.lang.String description)

Generates a VOTable XML document corresponding to the internal model

Parameters:

votable - SavotVOTable

file - String

stream - OutputStream

initStream

public void initStream(java.lang.String file)

Init the Stream for the output

Parameters:

file - String

initStream

public void initStream(java.io.OutputStream stream)

Init the Stream for the output

Parameters:

stream - OutputStream

writeComment

public void writeComment(java.lang.String comment)

Write a comment

Parameters:

comment - String

writeDocumentHead

public void writeDocumentHead(SavotVOTable votable)

Write a VOTable XML head

Parameters:

votable -

writeDocumentEnd

public void writeDocumentEnd()

Write a VOTable XML end

Parameters:

votable -

writeCoosys

public void writeCoosys(CoosysSet coosysSet)

Write a COOSYS set

Parameters:

coosysSet -

writeParam

public void writeParam(ParamSet params)

Write a PARAM set

Parameters:

params -

writeParamRef

public void writeParamRef(ParamRefSet refparams)

Write a PARAMref set

Parameters:

refparams -

writeLink

public void writeLink(LinkSet linkSet)

Write a LINK set

Parameters:

linkSet -

writeInfo

public void writeInfo(InfoSet infoSet)

Write an INFO set

Parameters:

infoSet -

writeField

public void writeField(FieldSet fieldSet)

Write a FIELD set

Parameters:

fieldSet -

writeFieldRef

public void writeFieldRef(FieldRefSet fieldRefSet)

Write a FIELD set

Parameters:

fieldRefSet -

writeStream

public void writeStream(SavotStream stream)

Write a STREAM element

Parameters:

stream -

writeBinary

public void writeBinary(SavotBinary binary)

Write a BINARY element

Parameters:

binary -

writeValues

public void writeValues(SavotValues values)

Write a VALUES element

Parameters:

values -

writeFits

public void writeFits(SavotFits fits)

Write a FITS element

Parameters:

fits -

writeMin

public void writeMin(SavotMin min)

Write a MIN element

Parameters:

min -

writeMax

public void writeMax(SavotMax max)

Write a MAX element

Parameters:

max -

writeOption

public void writeOption(OptionSet optionSet)

Write an OPTION set

Parameters:

optionSet -

writeGroup

public void writeGroup(GroupSet groupSet)

Write a GROUP set

Parameters:

groupSet -

writeTableBegin

public void writeTableBegin(SavotTable table)

Write a TABLE begin

Parameters:

table - SavotTable

writeTableEnd

public void writeTableEnd()

Write a TABLE end

writeResourceBegin

public void writeResourceBegin(SavotResource resource)

Write a RESOURCE begin

Parameters:

resource - SavotResource

writeResourceEnd

public void writeResourceEnd()

Write a RESOURCE end

writeTableDataBegin

public void writeTableDataBegin()

Write a TABLEDATA begin

writeTableDataEnd

public void writeTableDataEnd()

Write a TABLEDATA end

writeDataBegin

public void writeDataBegin()

Write a DATA begin

writeDataEnd

public void writeDataEnd()

Write a DATA end

writeTR

public void writeTR(SavotTR tr)

Write a TR

writeResource

public void writeResource(ResourceSet resourceset)

Write a RESOURCE set

Parameters:

resourceset - ResourceSet