org.orekit.files.ccsds.utils.generation

Class XmlGenerator

java.lang.Object

org.orekit.files.ccsds.utils.generation.AbstractGenerator

org.orekit.files.ccsds.utils.generation.XmlGenerator

All Implemented Interfaces:

AutoCloseable, Generator

public class XmlGenerator
extends AbstractGenerator

Generator for eXtended Markup Language CCSDS messages.

Since:

11.0

Author:

Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDENT Default number of space for each indentation level.
static String	UNITS Name of the units attribute.

Constructor Summary

Constructors

Constructor and Description
XmlGenerator(Appendable output, int indentation, String outputName, boolean writeUnits) Simple constructor.

Method Summary

Modifier and Type	Method and Description
void	endMessage(String root) End CCSDS message.
void	enterSection(String name) Enter into a new section.
String	exitSection() Exit last section.
FileFormat	getFormat() Get the generated file format.
void	startMessage(String root, String messageTypeKey, double version) Start CCSDS message.
void	writeComments(List<String> comments) Write comment lines.
void	writeEntry(String key, String value, Unit unit, boolean mandatory) Write a single key/value entry.
void	writeOneAttributeElement(String name, String value, String attributeName, String attributeValue) Write an element with one attribute.
void	writeTwoAttributesElement(String name, String value, String attribute1Name, String attribute1Value, String attribute2Name, String attribute2Value) Write an element with two attributes.

Methods inherited from class org.orekit.files.ccsds.utils.generation.AbstractGenerator

close, complain, dateToString, dateToString, doubleToString, getOutputName, newLine, siToCcsdsName, unitsListToString, writeEntry, writeEntry, writeEntry, writeEntry, writeEntry, writeEntry, writeEntry, writeRawData, writeRawData, writeUnits

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDENT

public static final int DEFAULT_INDENT

Default number of space for each indentation level.

See Also:

Constant Field Values

UNITS

public static final String UNITS

Name of the units attribute.

See Also:

Constant Field Values

Constructor Detail

XmlGenerator

public XmlGenerator(Appendable output,
                    int indentation,
                    String outputName,
                    boolean writeUnits)
             throws IOException

Simple constructor.

Parameters:

output - destination of generated output

indentation - number of space for each indentation level

outputName - output name for error messages

writeUnits - if true, units must be written

Throws:

IOException - if an I/O error occurs.

See Also:

DEFAULT_INDENT

Method Detail

getFormat

public FileFormat getFormat()

Get the generated file format.

Returns:

generated file format

startMessage

public void startMessage(String root,
                         String messageTypeKey,
                         double version)
                  throws IOException

Start CCSDS message.

Parameters:

root - root element for XML files

messageTypeKey - key for message type

version - format version

Throws:

IOException - if an I/O error occurs.

endMessage

public void endMessage(String root)
                throws IOException

End CCSDS message.

Parameters:

root - root element for XML files

Throws:

IOException - if an I/O error occurs.

writeComments

public void writeComments(List<String> comments)
                   throws IOException

Write comment lines.

Parameters:

comments - comments to write

Throws:

IOException - if an I/O error occurs.

writeOneAttributeElement

public void writeOneAttributeElement(String name,
                                     String value,
                                     String attributeName,
                                     String attributeValue)
                              throws IOException

Write an element with one attribute.

Parameters:

name - tag name

value - element value

attributeName - attribute name

attributeValue - attribute value

Throws:

IOException - if an I/O error occurs.

writeTwoAttributesElement

public void writeTwoAttributesElement(String name,
                                      String value,
                                      String attribute1Name,
                                      String attribute1Value,
                                      String attribute2Name,
                                      String attribute2Value)
                               throws IOException

Write an element with two attributes.

Parameters:

name - tag name

value - element value

attribute1Name - attribute 1 name

attribute1Value - attribute 1 value

attribute2Name - attribute 2 name

attribute2Value - attribute 2 value

Throws:

IOException - if an I/O error occurs.

writeEntry

public void writeEntry(String key,
                       String value,
                       Unit unit,
                       boolean mandatory)
                throws IOException

Write a single key/value entry.

Parameters:

key - the keyword to write

value - the value to write

unit - output unit (may be null)

mandatory - if true, null values triggers exception, otherwise they are silently ignored

Throws:

IOException - if an I/O error occurs.

enterSection

public void enterSection(String name)
                  throws IOException

Enter into a new section.

Specified by:

enterSection in interface Generator

Overrides:

enterSection in class AbstractGenerator

Parameters:

name - section name

Throws:

IOException - if an I/O error occurs.

exitSection

public String exitSection()
                   throws IOException

Exit last section.

Specified by:

exitSection in interface Generator

Overrides:

exitSection in class AbstractGenerator

Returns:

section name

Throws:

IOException - if an I/O error occurs.