io.jbotsim.io.format.xml

Class XMLParser

java.lang.Object

io.jbotsim.io.format.xml.XMLParser

Direct Known Subclasses:

XMLTopologyParser, XMLTraceParser

public abstract class XMLParser
extends java.lang.Object

Base class for manipulation of XML documents that store JBotSim objects.

The class proposes several helper functions used to load and interpret a document; IO operations use XMLIO methods. It parses the root node of the document to determine the version of the XSD schema used to format the document; then it delegates the interpretation of XML element to subclasses.

See Also:

parseRootElement(org.w3c.dom.Element)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	XMLParser.ElementVisitor A visitor class that may raise a XMLParser.ParserException.
static class	XMLParser.ParserException Exception raised whenever an error occurs while interpreting the XML document.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLParser(boolean validateDocument)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getVersion() Gets the version of the interpreted document.
protected static void	mapElementChildrenOf(org.w3c.dom.Node parent, XMLParser.ElementVisitor v) Applies a visitor function to all children elements of a node.
void	parse(org.w3c.dom.Document doc) Interprets a JBotSim XML document.
void	parse(java.io.InputStream input) Load and parses the document from the given input stream.
void	parseFromString(java.lang.String input) Loads and parses the document from the given string.
abstract void	parseRootElement(org.w3c.dom.Element element) Interprets the root element of the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLParser

protected XMLParser(boolean validateDocument)

Method Detail

getVersion

public java.lang.String getVersion()

Gets the version of the interpreted document.

Returns:

the version of underlying document.

parse

public void parse(java.io.InputStream input)
           throws XMLParser.ParserException

Load and parses the document from the given input stream.

Parameters:

input - the stream from which the document is read.

Throws:

XMLParser.ParserException - raised if an IO error occurs or if the XML document is malformed.

parseFromString

public void parseFromString(java.lang.String input)
                     throws XMLParser.ParserException

Loads and parses the document from the given string.

Parameters:

input - the string containing the document

Throws:

XMLParser.ParserException - raised if an IO error occurs or if the XML document is malformed.

parse

public void parse(org.w3c.dom.Document doc)
           throws XMLParser.ParserException

Interprets a JBotSim XML document.

First the document is validated wrt the JBotSim schema and then it is interpreted to build JBotSim objects. The methods checks if the root element of the document labelled with the jbotsim keyword and if it has a version attribute in which case its value is stored (mainly) for subclasses usage.

Finally the first child of the jbotsim element is passed to parseRootElement(Element) method that must be implemented by subclasses.

Parameters:

doc - the document that is interpreted

Throws:

XMLParser.ParserException - raised if an IO error occurs or if the XML document is malformed.

parseRootElement

public abstract void parseRootElement(org.w3c.dom.Element element)
                               throws XMLParser.ParserException

Interprets the root element of the document. This element is the first one found under the actual root element of the document. It is interpreted by subclasses according to the version attribute of the root element.

Parameters:

element - the element to be interpreted.

Throws:

XMLParser.ParserException - raised if an IO error occurs or if the XML document is malformed.

mapElementChildrenOf

protected static void mapElementChildrenOf(org.w3c.dom.Node parent,
                                           XMLParser.ElementVisitor v)
                                    throws XMLParser.ParserException

Applies a visitor function to all children elements of a node.

Parameters:

parent - the node for which the children are visited.

v - the visitor function.

Throws:

XMLParser.ParserException - raised if an IO error occurs or if the XML document is malformed.