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

Class XmlRendererHelper

java.lang.Object

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

public class XmlRendererHelper
extends java.lang.Object

Collection of methods helps to build a XML structure.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlRendererHelper() Initializes the internal XML structure.

Method Summary

Modifier and Type	Method and Description
void	append(org.w3c.dom.Node parent, org.w3c.dom.Node child) Safe appending of a child node to the parent one.
org.w3c.dom.Element	appendRootElement(java.lang.String name, Attribute... attributes) Defines the root element of the XML structure.
org.w3c.dom.Element	createElement(java.lang.String name) Creates an empty element with given tag name.
org.w3c.dom.Element	createElement(java.lang.String name, java.lang.Boolean content) Creates an element with rendered value from the given boolean.
org.w3c.dom.Element	createElement(java.lang.String name, java.util.Date content) Creates an element with rendered value from the given date.
org.w3c.dom.Element	createElement(java.lang.String name, java.util.Date content, java.lang.String format) Creates an element with rendered value from the given date with the given format.
org.w3c.dom.Element	createElement(java.lang.String name, java.lang.Number content) Creates an element with rendered value from the given number.
org.w3c.dom.Element	createElement(java.lang.String name, java.lang.Number content, java.lang.Number invaldValue) Creates an element with rendered value from the given number.
org.w3c.dom.Element	createElement(java.lang.String name, java.lang.String content) Creates an element with the given content.
org.w3c.dom.Element	createElement(java.lang.String parentName, java.lang.String childName, java.util.List<java.lang.String> list) Creates an parent element with child elements.
java.lang.String	getXml() Renders the built XML structure as text.
void	setAttribute(org.w3c.dom.Element node, Attribute attribute) Safe setting of an attribute to the node.
void	setContent(org.w3c.dom.Element node, java.lang.String content) Safe setting of a content to a XML element.
protected static java.lang.String	toXml(org.w3c.dom.Node node, javax.xml.transform.Transformer transformer) Returns the built XML structure as text.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlRendererHelper

protected XmlRendererHelper()
                     throws XmlRendererHelperException

Initializes the internal XML structure.

Throws:

XmlRendererHelperException - thrown in case of XML parser or XML transformer exceptions

Method Detail

appendRootElement

public org.w3c.dom.Element appendRootElement(java.lang.String name,
                                             Attribute... attributes)
                                      throws XmlRendererHelperException

Defines the root element of the XML structure.

Parameters:

name - tag name of root element

attributes - element attributes

Returns:

the built XML element

Throws:

XmlRendererHelperException - thrown if the root element is already defined

append

public void append(org.w3c.dom.Node parent,
                   org.w3c.dom.Node child)

Safe appending of a child node to the parent one.

Parameters:

parent - the parent

child - the child

createElement

public org.w3c.dom.Element createElement(java.lang.String name)

Creates an empty element with given tag name.

Parameters:

name - tag name

Returns:

null if name is not set or is null

createElement

public org.w3c.dom.Element createElement(java.lang.String name,
                                         java.lang.String content)

Creates an element with the given content.

Parameters:

name - tag name

content - content as text

Returns:

the created element

createElement

public org.w3c.dom.Element createElement(java.lang.String name,
                                         java.lang.Number content)

Creates an element with rendered value from the given number.

Parameters:

name - tag name

content - content as number

Returns:

the created element

createElement

public org.w3c.dom.Element createElement(java.lang.String name,
                                         java.lang.Number content,
                                         java.lang.Number invaldValue)

Creates an element with rendered value from the given number.

Parameters:

name - tag name

content - content as number

invaldValue - defined the invalid value. It's needed to control if an element should be created

Returns:

the created element or null if content is null or equals to the invalid value

createElement

public org.w3c.dom.Element createElement(java.lang.String name,
                                         java.util.Date content)

Creates an element with rendered value from the given date.

Parameters:

name - tag name

content - content as date

Returns:

the created element

createElement

public org.w3c.dom.Element createElement(java.lang.String name,
                                         java.util.Date content,
                                         java.lang.String format)

Creates an element with rendered value from the given date with the given format.

Parameters:

name - tag name

content - content as date

format - date format

Returns:

the created element

createElement

public org.w3c.dom.Element createElement(java.lang.String name,
                                         java.lang.Boolean content)

Creates an element with rendered value from the given boolean.

Parameters:

name - tag name

content - content as boolean

Returns:

the created element

createElement

public org.w3c.dom.Element createElement(java.lang.String parentName,
                                         java.lang.String childName,
                                         java.util.List<java.lang.String> list)

Creates an parent element with child elements.

Parameters:

parentName - the tag name of the parent element

childName - the tag name of child elements

list - the list with the child element contents

Returns:

the parent node with the children nodes created from given values

toXml

protected static java.lang.String toXml(org.w3c.dom.Node node,
                                        javax.xml.transform.Transformer transformer)
                                 throws XmlRendererHelperException

Returns the built XML structure as text.

Parameters:

node - XML node

transformer - XML transformer

Returns:

built XML as text

Throws:

XmlRendererHelperException - thrown in case of transformer exception

getXml

public java.lang.String getXml()
                        throws XmlRendererHelperException

Renders the built XML structure as text.

Returns:

rendered XML structure as text

Throws:

XmlRendererHelperException - thrown in case of transformer exception

setAttribute

public void setAttribute(org.w3c.dom.Element node,
                         Attribute attribute)

Safe setting of an attribute to the node.

Parameters:

node - the node

attribute - the attribute

setContent

public void setContent(org.w3c.dom.Element node,
                       java.lang.String content)

Safe setting of a content to a XML element.

Parameters:

node - XML element

content - content