Package org.yamcs.xtce.xml

Class AbstractStaxReader

java.lang.Object

org.yamcs.xtce.xml.AbstractStaxReader

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

XtceStaxReader

public class AbstractStaxReader
extends Object
implements AutoCloseable

Abstract class for XML readers

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	fileName
protected XMLEvent	xmlEvent
protected final XMLEventReader	xmlEventReader

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStaxReader(String fileName)

Method Summary

Modifier and Type	Method	Description
protected StartElement	checkStartElementPreconditions()	Checks preconditions before the dedicated code for section reading will run
void	close()
protected boolean	hasAttribute(String attName, StartElement element)
protected boolean	hasAttributes(StartElement element)	Examines element for presence of attributes
protected boolean	isEndElementWithName(String localName)	Test if the xmlEvent is of type END_ELEMENT and has particular local name.
protected boolean	isStartElementWithName(String localName)	Check if xml element is a start element with particular name
protected String	readAttribute(String attName, StartElement element, String defaultValue)
protected boolean	readBooleanAttribute(String attName, StartElement element, boolean defaultValue)
protected double	readDoubleAttribute(String attName, StartElement element)
protected double	readDoubleAttribute(String attName, StartElement element, double defaultValue)
protected int	readIntAttribute(String attName, StartElement element)
protected int	readIntAttribute(String attName, StartElement element, int defaultValue)
protected long	readLongAttribute(String attName, StartElement element)
protected long	readLongAttribute(String attName, StartElement element, long defaultValue)
protected String	readMandatoryAttribute(String attName, StartElement element)	Get attribute values as string
protected String	readStringBetweenTags(String tagName)

Methods inherited from class java.lang.Object

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

Field Details

xmlEventReader

protected final XMLEventReader xmlEventReader

fileName

protected final String fileName

xmlEvent

protected XMLEvent xmlEvent

Constructor Details

AbstractStaxReader

protected AbstractStaxReader(String fileName)
                      throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

Method Details

hasAttributes

protected boolean hasAttributes(StartElement element)

Examines element for presence of attributes

Parameters:

element - Element to be examined, should not be null

Returns:

True, if the element contains attributes, otherwise false

isStartElementWithName

protected boolean isStartElementWithName(String localName)

Check if xml element is a start element with particular name

Parameters:

localName - Name of the element

Returns:

True if element is start element with the given name, otherwise false

readStringBetweenTags

protected String readStringBetweenTags(String tagName)
                                throws XMLStreamException

Throws:

XMLStreamException

checkStartElementPreconditions

protected StartElement checkStartElementPreconditions()
                                               throws IllegalStateException

Checks preconditions before the dedicated code for section reading will run

Returns:

Throws:

IllegalStateException - If the conditions are not met

hasAttribute

protected boolean hasAttribute(String attName,
 StartElement element)
                        throws XMLStreamException

Throws:

XMLStreamException

readMandatoryAttribute

protected String readMandatoryAttribute(String attName,
 StartElement element)
                                 throws XMLStreamException

Get attribute values as string

Parameters:

attName - Name of the attribute

element - Start element which the attribute is read from

Returns:

Attribute's value as string

Throws:

XMLStreamException - - if the attribute does not exist

readAttribute

protected String readAttribute(String attName,
 StartElement element,
 String defaultValue)

readIntAttribute

protected int readIntAttribute(String attName,
 StartElement element,
 int defaultValue)
                        throws XMLStreamException

Throws:

XMLStreamException

readIntAttribute

protected int readIntAttribute(String attName,
 StartElement element)
                        throws XMLStreamException

Throws:

XMLStreamException

readLongAttribute

protected long readLongAttribute(String attName,
 StartElement element)
                          throws XMLStreamException

Throws:

XMLStreamException

readLongAttribute

protected long readLongAttribute(String attName,
 StartElement element,
 long defaultValue)
                          throws XMLStreamException

Throws:

XMLStreamException

readDoubleAttribute

protected double readDoubleAttribute(String attName,
 StartElement element)
                              throws XMLStreamException

Throws:

XMLStreamException

readDoubleAttribute

protected double readDoubleAttribute(String attName,
 StartElement element,
 double defaultValue)
                              throws XMLStreamException

Throws:

XMLStreamException

readBooleanAttribute

protected boolean readBooleanAttribute(String attName,
 StartElement element,
 boolean defaultValue)
                                throws XMLStreamException

Throws:

XMLStreamException

isEndElementWithName

protected boolean isEndElementWithName(String localName)

Test if the xmlEvent is of type END_ELEMENT and has particular local name. This test is used to identify the end of section.

Parameters:

localName - Local name of the element (we neglect namespace for now)

Returns:

True if current xmlEvent is of type END_ELEMENT and has particular local name, otherwise false

close

public void close()
           throws XMLStreamException,
IOException

Specified by:

close in interface AutoCloseable

Throws:

XMLStreamException

IOException