Package org.yamcs.xtce.xml

Class XtceStaxReader

java.lang.Object

org.yamcs.xtce.xml.AbstractStaxReader

org.yamcs.xtce.xml.XtceStaxReader

All Implemented Interfaces:

AutoCloseable

public class XtceStaxReader
extends AbstractStaxReader

This class reads the XTCE XML files. XML document is accessed with the use of the Stax Iterator API.

Field Summary

Fields

Modifier and Type	Field	Description
static final DynamicIntegerValue	IGNORED_DYNAMIC_VALUE

Fields inherited from class org.yamcs.xtce.xml.AbstractStaxReader

fileName, xmlEvent, xmlEventReader

Constructor Summary

Constructors

Constructor	Description
XtceStaxReader(String fileName)

Method Summary

Modifier and Type	Method	Description
static ParameterReference	getParameterReference(SpaceSystem spaceSystem, String paramName)
static void	makeParameterReference(SpaceSystem spaceSystem, String paramRef, ParameterReference.ParameterResolvedAction action)
SpaceSystem	readXmlDocument()	Reads the XML XTCE file
void	setExcludedContainers(Set<String> excludedContainers)
void	writeStatistics()	Write statistics.

Methods inherited from class org.yamcs.xtce.xml.AbstractStaxReader

checkStartElementPreconditions, close, hasAttribute, hasAttributes, isEndElementWithName, isStartElementWithName, readAttribute, readBooleanAttribute, readDoubleAttribute, readDoubleAttribute, readIntAttribute, readIntAttribute, readLongAttribute, readLongAttribute, readMandatoryAttribute, readStringBetweenTags

Methods inherited from class java.lang.Object

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

Field Details

IGNORED_DYNAMIC_VALUE

public static final DynamicIntegerValue IGNORED_DYNAMIC_VALUE

Constructor Details

XtceStaxReader

public XtceStaxReader(String fileName)
               throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

Method Details

readXmlDocument

public SpaceSystem readXmlDocument()
                            throws XMLStreamException,
IOException,
XtceLoadException

Reads the XML XTCE file

Returns:

returns the SpaceSystem read from the XML file

Throws:

XMLStreamException

IOException

XtceLoadException

writeStatistics

public void writeStatistics()

Write statistics.

setExcludedContainers

public void setExcludedContainers(Set<String> excludedContainers)

getParameterReference

public static ParameterReference getParameterReference(SpaceSystem spaceSystem,
 String paramName)

makeParameterReference

public static void makeParameterReference(SpaceSystem spaceSystem,
 String paramRef,
 ParameterReference.ParameterResolvedAction action)