SavotWriter (SAVOT API)

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

```
public final class SavotWriter
extends java.lang.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

Constructors
Constructor	Description
`SavotWriter()`	Public constructor

Method Summary

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

Class SavotWriter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SavotWriter

Method Detail

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