java.lang.Object

cds.savot.writer.SavotWriter

public final class SavotWriter extends Object

VOTable document generation from memory

Author:: Andre Schaaff 6 June 2005 : the user can now write a VOTable document flow step by step, the previous method is available too (writing of a whole document) (kickoff 31 May 02)

Constructor Summary

Constructors

Constructor

Description

SavotWriter()

Public constructor
Method Summary

Modifier and Type

Method

Description

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

String

encodeAttribute(String src)

Encode special characters to entities

String

encodeElement(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, OutputStream stream)

Generates a VOTable XML document corresponding to the internal model

void

generateDocument(SavotVOTable votable, String file)

Generates a VOTable XML document corresponding to the internal model

void

generateDocument(SavotVOTable votable, String file, OutputStream stream)

Generates a VOTable XML document corresponding to the internal model

void

initStream(OutputStream stream)

Init the Stream for the output

void

initStream(Writer writer)

Init the Stream for the output using the given Writer

void

initStream(String file)

Init the Stream for the output

void

setStyleSheet(String href)

Set a stylesheet Also possible with setTop1

void

setTop1(String top1)

Change the default XML document head Default value invalid input: '<'?xml version="1.0 encoding="UTF-8"?>

void

writeBinary(SavotBinary binary)

Write a BINARY element

void

writeComment(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(String description)

Write a description

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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SavotWriter
  
  public SavotWriter()
  
  Public constructor
Method Details
- setTop1
  
  public void setTop1(String top1)
  
  Change the default XML document head Default value invalid input: '<'?xml version="1.0 encoding="UTF-8"?>
  
  Parameters:
  
  top1 -
  
  Since:
  
  VOTable 1.2
- setStyleSheet
  
  public void setStyleSheet(String href)
  
  Set a stylesheet Also possible with setTop1
  
  Parameters:
  
  href -
  
  Since:
  
  VOTable 1.2
- 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 String encodeAttribute(String src)
  
  Encode special characters to entities
  
  Parameters:
  
  src -
  
  Returns:
  
  src
- encodeElement
  
  public String encodeElement(String src)
  
  Encode special characters to entities
  
  Parameters:
  
  src -
  
  Returns:
  
  src
- generateDocument
  
  public void generateDocument(SavotVOTable votable) throws IOException
  
  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
  
  Throws:
  
  IOException
- generateDocument
  
  public void generateDocument(SavotVOTable votable, OutputStream stream) throws IOException
  
  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
  
  Throws:
  
  IOException
- generateDocument
  
  public void generateDocument(SavotVOTable votable, String file) throws IOException
  
  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
  
  Throws:
  
  IOException
- generateDocument
  
  public void generateDocument(SavotVOTable votable, String file, OutputStream stream) throws IOException
  
  Generates a VOTable XML document corresponding to the internal model
  
  Parameters:
  
  votable - SavotVOTable
  
  file - String
  
  stream - OutputStream
  
  Throws:
  
  IOException
- initStream
  
  public void initStream(String file) throws IOException
  
  Init the Stream for the output
  
  Parameters:
  
  file - String
  
  Throws:
  
  IOException
- initStream
  
  public void initStream(OutputStream stream) throws IOException
  
  Init the Stream for the output
  
  Parameters:
  
  stream - OutputStream
  
  Throws:
  
  IOException
- initStream
  
  public void initStream(Writer writer)
  
  Init the Stream for the output using the given Writer
  
  Parameters:
  
  writer - writer implementation to write into
- writeComment
  
  public void writeComment(String comment) throws IOException
  
  Write a comment
  
  Parameters:
  
  comment - String
  
  Throws:
  
  IOException
- writeDescription
  
  public void writeDescription(String description) throws IOException
  
  Write a description
  
  Parameters:
  
  description -
  
  Throws:
  
  IOException
- writeDocumentHead
  
  public void writeDocumentHead(SavotVOTable votable) throws IOException
  
  Write a VOTable XML head
  
  Parameters:
  
  votable -
  
  Throws:
  
  IOException
- writeDocumentEnd
  
  public void writeDocumentEnd() throws IOException
  
  Write a VOTable XML end
  
  Throws:
  
  IOException
- writeCoosys
  
  public void writeCoosys(CoosysSet coosysSet) throws IOException
  
  Write a COOSYS set
  
  Parameters:
  
  coosysSet -
  
  Throws:
  
  IOException
- writeParam
  
  public void writeParam(ParamSet params) throws IOException
  
  Write a PARAM set
  
  Parameters:
  
  params -
  
  Throws:
  
  IOException
- writeParamRef
  
  public void writeParamRef(ParamRefSet refparams) throws IOException
  
  Write a PARAMref set
  
  Parameters:
  
  refparams -
  
  Throws:
  
  IOException
- writeLink
  
  public void writeLink(LinkSet linkSet) throws IOException
  
  Write a LINK set
  
  Parameters:
  
  linkSet -
  
  Throws:
  
  IOException
- writeInfo
  
  public void writeInfo(InfoSet infoSet) throws IOException
  
  Write an INFO set
  
  Parameters:
  
  infoSet -
  
  Throws:
  
  IOException
- writeField
  
  public void writeField(FieldSet fieldSet) throws IOException
  
  Write a FIELD set
  
  Parameters:
  
  fieldSet -
  
  Throws:
  
  IOException
- writeFieldRef
  
  public void writeFieldRef(FieldRefSet fieldRefSet) throws IOException
  
  Write a FIELD set
  
  Parameters:
  
  fieldRefSet -
  
  Throws:
  
  IOException
- writeStream
  
  public void writeStream(SavotStream stream) throws IOException
  
  Write a STREAM element
  
  Parameters:
  
  stream -
  
  Throws:
  
  IOException
- writeBinary
  
  public void writeBinary(SavotBinary binary) throws IOException
  
  Write a BINARY element
  
  Parameters:
  
  binary -
  
  Throws:
  
  IOException
- writeValues
  
  public void writeValues(SavotValues values) throws IOException
  
  Write a VALUES element
  
  Parameters:
  
  values -
  
  Throws:
  
  IOException
- writeFits
  
  public void writeFits(SavotFits fits) throws IOException
  
  Write a FITS element
  
  Parameters:
  
  fits -
  
  Throws:
  
  IOException
- writeMin
  
  public void writeMin(SavotMin min) throws IOException
  
  Write a MIN element
  
  Parameters:
  
  min -
  
  Throws:
  
  IOException
- writeMax
  
  public void writeMax(SavotMax max) throws IOException
  
  Write a MAX element
  
  Parameters:
  
  max -
  
  Throws:
  
  IOException
- writeOption
  
  public void writeOption(OptionSet optionSet) throws IOException
  
  Write an OPTION set
  
  Parameters:
  
  optionSet -
  
  Throws:
  
  IOException
- writeGroup
  
  public void writeGroup(GroupSet groupSet) throws IOException
  
  Write a GROUP set
  
  Parameters:
  
  groupSet -
  
  Throws:
  
  IOException
- writeTableBegin
  
  public void writeTableBegin(SavotTable table) throws IOException
  
  Write a TABLE begin
  
  Parameters:
  
  table - SavotTable
  
  Throws:
  
  IOException
- writeTableEnd
  
  public void writeTableEnd() throws IOException
  
  Write a TABLE end
  
  Throws:
  
  IOException
- writeResourceBegin
  
  public void writeResourceBegin(SavotResource resource) throws IOException
  
  Write a RESOURCE begin
  
  Parameters:
  
  resource - SavotResource
  
  Throws:
  
  IOException
- writeResourceEnd
  
  public void writeResourceEnd() throws IOException
  
  Write a RESOURCE end
  
  Throws:
  
  IOException
- writeTableDataBegin
  
  public void writeTableDataBegin() throws IOException
  
  Write a TABLEDATA begin
  
  Throws:
  
  IOException
- writeTableDataEnd
  
  public void writeTableDataEnd() throws IOException
  
  Write a TABLEDATA end
  
  Throws:
  
  IOException
- writeDataBegin
  
  public void writeDataBegin() throws IOException
  
  Write a DATA begin
  
  Throws:
  
  IOException
- writeDataEnd
  
  public void writeDataEnd() throws IOException
  
  Write a DATA end
  
  Throws:
  
  IOException
- writeTR
  
  public void writeTR(SavotTR tr) throws IOException
  
  Write a TR
  
  Parameters:
  
  tr -
  
  Throws:
  
  IOException
- writeResource
  
  public void writeResource(ResourceSet resourceset) throws IOException
  
  Write a RESOURCE set
  
  Parameters:
  
  resourceset - ResourceSet
  
  Throws:
  
  IOException

Class SavotWriter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

SavotWriter

Method Details

setTop1

setStyleSheet

enableAttributeEntities

enableElementEntities

enableEntities

encodeAttribute

encodeElement

generateDocument

generateDocument

generateDocument

generateDocument

initStream

initStream

initStream

writeComment

writeDescription

writeDocumentHead

writeDocumentEnd

writeCoosys

writeParam

writeParamRef

writeLink

writeInfo

writeField

writeFieldRef

writeStream

writeBinary

writeValues

writeFits

writeMin

writeMax

writeOption

writeGroup

writeTableBegin

writeTableEnd

writeResourceBegin

writeResourceEnd

writeTableDataBegin

writeTableDataEnd

writeDataBegin

writeDataEnd

writeTR

writeResource