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

用于生成扩展标记语言CCSDS消息的生成器。

Since:

11.0

Author:

Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDENT 每个缩进级别的默认空格数。
static String	NDM_XML_V3_SCHEMA_LOCATION NDM/XML版本3的位置。
static String	UNITS 单位属性的名称。

Constructor Summary

Constructors

Constructor and Description
XmlGenerator(Appendable output, int indentation, String outputName, double maxRelativeOffset, boolean writeUnits, String schemaLocation) 简单构造函数。

Method Summary

Modifier and Type	Method and Description
void	endMessage(String root) 结束CCSDS消息。
void	enterSection(String name) 进入新的部分。
String	exitSection() 退出上一个部分。
FileFormat	getFormat() 获取生成的文件格式。
void	startMessage(String root, String messageTypeKey, double version) 开始CCSDS消息。
void	writeComments(List<String> comments) 写入注释行。
void	writeEntry(String key, String value, Unit unit, boolean mandatory) 写入单个键/值条目。
void	writeOneAttributeElement(String name, String value, String attributeName, String attributeValue) 写入具有一个属性的元素。
void	writeTwoAttributesElement(String name, String value, String attribute1Name, String attribute1Value, String attribute2Name, String attribute2Value) 写入具有两个属性的元素。

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

close, complain, dateToCalendarString, 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

每个缩进级别的默认空格数。

另请参阅:

常量字段值

UNITS

public static final String UNITS

单位属性的名称。

另请参阅:

常量字段值

NDM_XML_V3_SCHEMA_LOCATION

public static final String NDM_XML_V3_SCHEMA_LOCATION

NDM/XML版本3的位置。

自从:

12.0

另请参阅:

常量字段值

Constructor Detail

XmlGenerator

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

简单构造函数。

参数:

output - 生成输出的目的地

indentation - 每个缩进级别的空格数

outputName - 错误消息的输出名称

maxRelativeOffset - 使用相对日期的最大偏移量（如果日期与参考日期相距太远，则将其显示为日历元素）

writeUnits - 如果为true，则必须写入单位

schemaLocation - 要使用的模式位置，可以为null

抛出:

IOException - 如果发生I/O错误。

另请参阅:

DEFAULT_INDENT, NDM_XML_V3_SCHEMA_LOCATION

Method Detail

getFormat

public FileFormat getFormat()

获取生成的文件格式。

返回:

生成的文件格式

startMessage

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

开始CCSDS消息。

参数:

root - XML文件的根元素

messageTypeKey - 消息类型的键

version - 格式版本

抛出:

IOException - 如果发生I/O错误。

endMessage

public void endMessage(String root)
                throws IOException

结束CCSDS消息。

参数:

root - XML文件的根元素

抛出:

IOException - 如果发生I/O错误。

writeComments

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

写入注释行。

参数:

comments - 要写入的注释

抛出:

IOException - 如果发生I/O错误。

writeOneAttributeElement

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

写入具有一个属性的元素。

参数:

name - 标记名称

value - 元素值

attributeName - 属性名称

attributeValue - 属性值

抛出:

IOException - 如果发生I/O错误。

writeTwoAttributesElement

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

写入具有两个属性的元素。

参数:

name - 标记名称

value - 元素值

attribute1Name - 属性1名称

attribute1Value - 属性1值

attribute2Name - 属性2名称

attribute2Value - 属性2值

抛出:

IOException - 如果发生I/O错误。

writeEntry

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

写入单个键/值条目。

参数:

key - 要写入的关键字

value - 要写入的值

unit - 输出单位（可以为null）

mandatory - 如果为true，则null值会触发异常，否则它们会被静默忽略

抛出:

IOException - 如果发生I/O错误。

enterSection

public void enterSection(String name)
                  throws IOException

进入新的部分。

由以下指定:

enterSection 在接口 Generator

覆盖:

enterSection 在类 AbstractGenerator

参数:

name - 部分名称

抛出:

IOException - 如果发生I/O错误。

exitSection

public String exitSection()
                   throws IOException

退出上一个部分。

由以下指定:

exitSection 在接口 Generator

覆盖:

exitSection 在类 AbstractGenerator

返回:

部分名称

抛出:

IOException - 如果发生I/O错误。