org.cip4.lib.xjdf.xml

Class XJmfParser

java.lang.Object

org.cip4.lib.xjdf.xml.internal.AbstractXmlParser<XJMF>

org.cip4.lib.xjdf.xml.XJmfParser

public class XJmfParser
extends AbstractXmlParser<XJMF>

Parsing logic for building a XML Document from XJMF DOM-Tree and the way around.

Constructor Summary

Constructors

Constructor and Description
XJmfParser() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected AbstractXmlValidator	createValidator() Create validator for validating documents.
protected com.sun.xml.bind.marshaller.NamespacePrefixMapper	getNamespacePrefixMapper() Returns a new specific NamespacePrefixMapper implementation.
protected java.lang.String	getXmlHeader() Returns the XML Header for marshaling.
byte[]	parseXJmf(XJMF xjmf) Parse a XJMF Object Tree to a byte array.
byte[]	parseXJmf(XJMF xjmf, boolean skipValidation) Parse a XJMF Object Tree to a byte array.
void	parseXJmf(XJMF xjmf, java.io.OutputStream os) Parse a XJMF Object Tree to a binary output stream.
void	parseXJmf(XJMF xjmf, java.io.OutputStream os, boolean skipValidation) Parse a XJMF Object Tree to a binary output stream.

Methods inherited from class org.cip4.lib.xjdf.xml.internal.AbstractXmlParser

parseNode, parseNode, parseStream, parseXml, parseXml, parseXml, parseXml

Methods inherited from class java.lang.Object

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

Constructor Detail

XJmfParser

public XJmfParser()
           throws javax.xml.bind.JAXBException

Default constructor.

Throws:

javax.xml.bind.JAXBException - Thrown in case a JAXBException occurs.

Method Detail

parseXJmf

public final void parseXJmf(XJMF xjmf,
                            java.io.OutputStream os)
                     throws javax.xml.parsers.ParserConfigurationException,
                            javax.xml.bind.JAXBException,
                            org.xml.sax.SAXException,
                            java.io.IOException

Parse a XJMF Object Tree to a binary output stream.

Parameters:

xjmf - XJMF Object Tree for parsing.

os - Target OutputStream where XJMF is being parsed.

Throws:

javax.xml.parsers.ParserConfigurationException - Is thrown in case a serious configuration error occurs.

javax.xml.bind.JAXBException - Is thrown in case any error while un-/marshalling occurs.

org.xml.sax.SAXException - Is thrown in case parsing an xml document fails.

java.io.IOException - Is thrown in case any IO error occurs.

parseXJmf

public final void parseXJmf(XJMF xjmf,
                            java.io.OutputStream os,
                            boolean skipValidation)
                     throws java.io.IOException,
                            javax.xml.parsers.ParserConfigurationException,
                            org.xml.sax.SAXException,
                            javax.xml.bind.JAXBException

Parse a XJMF Object Tree to a binary output stream.

Parameters:

xjmf - XJMF Object Tree for parsing.

os - Target OutputStream where XJMF is being parsed.

skipValidation - Skip validation.

Throws:

java.io.IOException - Is thrown in case any IO error occurs.

javax.xml.parsers.ParserConfigurationException - Is thrown in case a serious configuration error occurs.

org.xml.sax.SAXException - Is thrown in case parsing an xml document fails.

javax.xml.bind.JAXBException - Is thrown in case any error while un-/marshalling occurs.

parseXJmf

public final byte[] parseXJmf(XJMF xjmf)
                       throws javax.xml.parsers.ParserConfigurationException,
                              java.io.IOException,
                              org.xml.sax.SAXException,
                              javax.xml.bind.JAXBException

Parse a XJMF Object Tree to a byte array.

Parameters:

xjmf - XJMF Object Tree for parsing.

Returns:

XJMF as byte array.

Throws:

javax.xml.parsers.ParserConfigurationException - Is thrown in case a serious configuration error occurs.

java.io.IOException - Is thrown in case any IO error occurs.

org.xml.sax.SAXException - Is thrown in case parsing an xml document fails.

javax.xml.bind.JAXBException - Is thrown in case any error while un-/marshalling occurs.

parseXJmf

public final byte[] parseXJmf(XJMF xjmf,
                              boolean skipValidation)
                       throws javax.xml.parsers.ParserConfigurationException,
                              javax.xml.bind.JAXBException,
                              org.xml.sax.SAXException,
                              java.io.IOException

Parse a XJMF Object Tree to a byte array.

Parameters:

xjmf - XJMF Object Tree for parsing.

skipValidation - Skip validation.

Returns:

XJMF as byte array.

Throws:

javax.xml.parsers.ParserConfigurationException - Is thrown in case a serious configuration error occurs.

javax.xml.bind.JAXBException - Is thrown in case any error while un-/marshalling occurs.

org.xml.sax.SAXException - Is thrown in case parsing an xml document fails.

java.io.IOException - Is thrown in case any IO error occurs.

getNamespacePrefixMapper

protected final com.sun.xml.bind.marshaller.NamespacePrefixMapper getNamespacePrefixMapper()

Description copied from class: AbstractXmlParser

Returns a new specific NamespacePrefixMapper implementation.

Specified by:

getNamespacePrefixMapper in class AbstractXmlParser<XJMF>

Returns:

New specific NamespacePrefixMapper implementation.

getXmlHeader

protected java.lang.String getXmlHeader()

Description copied from class: AbstractXmlParser

Returns the XML Header for marshaling.

Specified by:

getXmlHeader in class AbstractXmlParser<XJMF>

Returns:

XML Header as String

createValidator

protected final AbstractXmlValidator createValidator()

Description copied from class: AbstractXmlParser

Create validator for validating documents.

Specified by:

createValidator in class AbstractXmlParser<XJMF>

Returns:

Validator