com.sofort.lib.core.internal.utils.xml

Class XmlParserHelper

java.lang.Object

com.sofort.lib.core.internal.utils.xml.XmlParserHelper

public class XmlParserHelper
extends java.lang.Object

XML parser helper.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlParserHelper() Defines a XML parser helper.

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Element	getChild(org.w3c.dom.Element parent, java.lang.String name) Get from parent the direct child with the given tag name.
java.util.List<org.w3c.dom.Element>	getChildren(org.w3c.dom.Element parent, java.lang.String name) Get from parent all children for the given tag name.
java.lang.String	getChildText(org.w3c.dom.Element parent, java.lang.String name) Safe getting of the content as a text value from the child with the given tag name.
boolean	getChildTextAsBoolean(org.w3c.dom.Element parent, java.lang.String name) Safe getting of the content as a boolean value from the child with the given tag name.
java.util.Date	getChildTextAsDate(org.w3c.dom.Element parent, java.lang.String name) Safe getting of the content as a date value from the child with the given tag name.
double	getChildTextAsDouble(org.w3c.dom.Element parent, java.lang.String name) Safe getting of the content as a double value from the child with the given tag name.
int	getChildTextAsInt(org.w3c.dom.Element parent, java.lang.String name) Safe getting of the content as a integer value from the child with the given tag name.
long	getChildTextAsLong(org.w3c.dom.Element parent, java.lang.String name) Safe getting of the content as a long value from the child with the given tag name.
java.util.Date	getChildTextAsShortDate(org.w3c.dom.Element parent, java.lang.String name) Safe getting of the content as a short value from the child with the given tag name.
java.lang.String	getName(org.w3c.dom.Node n) Returns the name of the node.
java.lang.String	getText(org.w3c.dom.Node n) Returns the content of the node and removes their path from the verifier.
org.w3c.dom.Document	parseXml(org.xml.sax.InputSource inputSource) Parses the XML stream to a Document.
org.w3c.dom.Document	parseXml(java.lang.String xml) Parses the text XML to a Document.
void	verify() Checks if the content of all parsed nodes was picked up.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlParserHelper

protected XmlParserHelper()

Defines a XML parser helper. Additionally a XML verifier is defined too. The verifier checks if the content of all parsed nodes was picked up.

Method Detail

verify

public void verify()
            throws XmlVerifierException

Checks if the content of all parsed nodes was picked up.

Throws:

XmlVerifierException - thrown if the content of not all nodes was picked up.

parseXml

public org.w3c.dom.Document parseXml(java.lang.String xml)
                              throws XmlParserHelperException

Parses the text XML to a Document.

Parameters:

xml - the xml

Returns:

the document

Throws:

XmlParserHelperException - thrown in case of any XML parsing exceptions

parseXml

public org.w3c.dom.Document parseXml(org.xml.sax.InputSource inputSource)
                              throws XmlParserHelperException

Parses the XML stream to a Document.

Parameters:

inputSource - the input source

Returns:

the document

Throws:

XmlParserHelperException - thrown in case of ParserConfiguration, SAX and IO exceptions

getText

public java.lang.String getText(org.w3c.dom.Node n)

Returns the content of the node and removes their path from the verifier.

Parameters:

n - node

Returns:

the content as text

getName

public java.lang.String getName(org.w3c.dom.Node n)

Returns the name of the node.

Parameters:

n - node

Returns:

the name of the node

getChild

public org.w3c.dom.Element getChild(org.w3c.dom.Element parent,
                                    java.lang.String name)

Get from parent the direct child with the given tag name.

Parameters:

parent - parent node

name - child tag name

Returns:

found node or null if not found

getChildren

public java.util.List<org.w3c.dom.Element> getChildren(org.w3c.dom.Element parent,
                                                       java.lang.String name)

Get from parent all children for the given tag name. Remove the path from verifier if the parent node hasn't any children.

Parameters:

parent - parent node

name - the children tag name

Returns:

the list of found children

getChildText

public java.lang.String getChildText(org.w3c.dom.Element parent,
                                     java.lang.String name)

Safe getting of the content as a text value from the child with the given tag name.

Parameters:

parent - parent XML element

name - the child name the content should be picked up

Returns:

the child content as a text value

getChildTextAsDouble

public double getChildTextAsDouble(org.w3c.dom.Element parent,
                                   java.lang.String name)

Safe getting of the content as a double value from the child with the given tag name.

Parameters:

parent - parent XML element

name - the child name the content should be picked up

Returns:

the child content as a double value

getChildTextAsLong

public long getChildTextAsLong(org.w3c.dom.Element parent,
                               java.lang.String name)

Safe getting of the content as a long value from the child with the given tag name.

Parameters:

parent - parent XML element

name - the child name the content should be picked up

Returns:

the child content as a long value

getChildTextAsInt

public int getChildTextAsInt(org.w3c.dom.Element parent,
                             java.lang.String name)

Safe getting of the content as a integer value from the child with the given tag name.

Parameters:

parent - parent XML element

name - the child name the content should be picked up

Returns:

the child content as a integer value

getChildTextAsBoolean

public boolean getChildTextAsBoolean(org.w3c.dom.Element parent,
                                     java.lang.String name)

Safe getting of the content as a boolean value from the child with the given tag name.

Parameters:

parent - parent XML element

name - the child name the content should be picked up

Returns:

the child content as a boolean value

getChildTextAsDate

public java.util.Date getChildTextAsDate(org.w3c.dom.Element parent,
                                         java.lang.String name)

Safe getting of the content as a date value from the child with the given tag name.

Parameters:

parent - parent XML element

name - the child name the content should be picked up

Returns:

the child content as a date value

getChildTextAsShortDate

public java.util.Date getChildTextAsShortDate(org.w3c.dom.Element parent,
                                              java.lang.String name)

Safe getting of the content as a short value from the child with the given tag name.

Parameters:

parent - parent XML element

name - the child name the content should be picked up

Returns:

the child content as a short value