Package org.camunda.spin.impl.xml.dom

Class DomXmlElement

java.lang.Object

org.camunda.spin.Spin<T>

org.camunda.spin.xml.SpinXmlNode<SpinXmlElement>

org.camunda.spin.xml.SpinXmlElement

org.camunda.spin.impl.xml.dom.DomXmlElement

public class DomXmlElement
extends SpinXmlElement

Wrapper for an xml dom element.

Author:

Sebastian Menski

Field Summary

Fields

Modifier and Type	Field	Description
protected static Transformer	cachedTransformer
protected static XPathFactory	cachedXPathFactory
protected final DomXmlDataFormat	dataFormat
protected final Element	domElement

Constructor Summary

Constructors

Constructor	Description
DomXmlElement(Element domElement, DomXmlDataFormat dataFormat)

Method Summary

Modifier and Type	Method	Description
protected void	adoptElement(DomXmlElement elementToAdopt)	Adopts an xml dom element to the owner document of this element if necessary.
SpinXmlElement	append(Collection<SpinXmlElement> childElements)	Appends child elements to this element.
SpinXmlElement	append(SpinXmlElement childElement)
SpinXmlElement	append(SpinXmlElement... childElements)	Appends child elements to this element.
SpinXmlElement	appendAfter(SpinXmlElement childElement, SpinXmlElement existingChildElement)	Appends a child element to this element after the existing child element.
SpinXmlElement	appendBefore(SpinXmlElement childElement, SpinXmlElement existingChildElement)	Appends a child element to this element before the existing child element.
SpinXmlAttribute	attr(String attributeName)	Returns the wrapped attribute for an empty namespace and the given name.
SpinXmlElement	attr(String attributeName, String value)	Sets the attribute value in the local namespace of this element.
List<String>	attrNames()	Returns all names of the attributes of this element.
List<String>	attrNames(String namespace)	Returns all names of the attributes in the given namespace.
SpinXmlAttribute	attrNs(String namespace, String attributeName)	Returns the wrapped attribute for the given namespace and name.
SpinXmlElement	attrNs(String namespace, String attributeName, String value)	Sets the attribute value in the given namespace.
SpinList<SpinXmlAttribute>	attrs()	Returns all wrapped attributes of this element.
SpinList<SpinXmlAttribute>	attrs(String namespace)	Returns all wrapped attributes for the given namespace.
SpinXmlElement	childElement(String elementName)	Returns a single wrapped child element for the given name in the local namespace of this element.
SpinXmlElement	childElement(String namespace, String elementName)	Returns a single wrapped child element for the given namespace and name.
SpinList<SpinXmlElement>	childElements()	Returns all child elements of this elements.
SpinList<SpinXmlElement>	childElements(String elementName)	Returns all child elements with a given name in the local namespace of this element.
SpinList<SpinXmlElement>	childElements(String namespace, String elementName)	Returns all child elements with a given namespace and name.
String	getDataFormatName()	Provides the name of the dataformat used by this spin.
protected XPathFactory	getXPathFactory()	Returns a XPath Factory
boolean	hasAttr(String attributeName)	Checks whether this element has a attribute with an empty namespace and the given name.
boolean	hasAttrNs(String namespace, String attributeName)	Checks whether this element has a attribute with the given namespace and name.
boolean	hasNamespace(String namespace)	Checks if the node has a given namespace.
boolean	hasPrefix(String prefix)	Checks if the node has a given prefix.
<C> C	mapTo(Class<C> javaClass)	Maps XML into specific class
<C> C	mapTo(String javaClass)	Maps Xml into specific class
String	name()	Returns the local name of the node without namespace or prefix.
String	namespace()	Returns the namespace uri of the node and not the prefix.
String	prefix()	Returns the prefix of the node and not the namespace uri.
SpinXmlElement	remove(Collection<SpinXmlElement> childElements)	Removes all child elements from this element.
SpinXmlElement	remove(SpinXmlElement childElement)
SpinXmlElement	remove(SpinXmlElement... childElements)	Removes all child elements from this element.
SpinXmlElement	removeAttr(String attributeName)	Removes the attribute with an empty namespace.
SpinXmlElement	removeAttrNs(String namespace, String attributeName)	Removes the attribute under the given namespace.
SpinXmlElement	replace(SpinXmlElement newElement)	Replaces this element by an new one.
SpinXmlElement	replaceChild(SpinXmlElement existingChildElement, SpinXmlElement newChildElement)	Replaces an existing child element with a new one.
String	textContent()	Returns the text content of an element.
SpinXmlElement	textContent(String textContent)	Sets the text content of an element.
String	toString()	Returns the wrapped XML element as string representation.
Element	unwrap()	Return the wrapped object.
void	writeToWriter(Writer writer)	Writes the wrapped XML element to a existing writer.
SpinXPathQuery	xPath(String expression)	Creates a XPath query on this element.

Methods inherited from class org.camunda.spin.Spin

JSON, S, S, S, XML

Methods inherited from class java.lang.Object

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

Field Details

cachedTransformer

protected static Transformer cachedTransformer

cachedXPathFactory

protected static XPathFactory cachedXPathFactory

domElement

protected final Element domElement

dataFormat

protected final DomXmlDataFormat dataFormat

Constructor Details

DomXmlElement

public DomXmlElement(Element domElement,
 DomXmlDataFormat dataFormat)

Method Details

getDataFormatName

public String getDataFormatName()

Description copied from class: Spin

Provides the name of the dataformat used by this spin.

Specified by:

getDataFormatName in class Spin<SpinXmlElement>

Returns:

the name of the dataformat used by this Spin.

unwrap

public Element unwrap()

Description copied from class: Spin

Return the wrapped object. The return type of this method depends on the concrete data format.

Specified by:

unwrap in class Spin<SpinXmlElement>

Returns:

the object wrapped by this wrapper.

name

public String name()

Description copied from class: SpinXmlNode

Returns the local name of the node without namespace or prefix.

Specified by:

name in class SpinXmlNode<SpinXmlElement>

Returns:

the name of the node

namespace

public String namespace()

Description copied from class: SpinXmlNode

Returns the namespace uri of the node and not the prefix.

Specified by:

namespace in class SpinXmlNode<SpinXmlElement>

Returns:

the namespace of the node

prefix

public String prefix()

Description copied from class: SpinXmlNode

Returns the prefix of the node and not the namespace uri.

Specified by:

prefix in class SpinXmlNode<SpinXmlElement>

Returns:

the prefix of the node

hasPrefix

public boolean hasPrefix(String prefix)

Description copied from class: SpinXmlNode

Checks if the node has a given prefix.

Specified by:

hasPrefix in class SpinXmlNode<SpinXmlElement>

Parameters:

prefix - the prefix to check

Returns:

true if the name has the same prefix

hasNamespace

public boolean hasNamespace(String namespace)

Description copied from class: SpinXmlNode

Checks if the node has a given namespace.

Specified by:

hasNamespace in class SpinXmlNode<SpinXmlElement>

Parameters:

namespace - the namespace to check

Returns:

true if the node has the same namespace

attr

public SpinXmlAttribute attr(String attributeName)

Description copied from class: SpinXmlElement

Returns the wrapped attribute for an empty namespace and the given name.

Specified by:

attr in class SpinXmlElement

Parameters:

attributeName - the name of the attribute

Returns:

the wrapped attribute

attrNs

public SpinXmlAttribute attrNs(String namespace,
 String attributeName)

Description copied from class: SpinXmlElement

Returns the wrapped attribute for the given namespace and name.

Specified by:

attrNs in class SpinXmlElement

Parameters:

namespace - the namespace of the attribute

attributeName - the name of the attribute

Returns:

the wrapped attribute

hasAttr

public boolean hasAttr(String attributeName)

Description copied from class: SpinXmlElement

Checks whether this element has a attribute with an empty namespace and the given name.

Specified by:

hasAttr in class SpinXmlElement

Parameters:

attributeName - the name of the attribute

Returns:

true if the element has an attribute with this name under the local namespace, false otherwise

hasAttrNs

public boolean hasAttrNs(String namespace,
 String attributeName)

Description copied from class: SpinXmlElement

Checks whether this element has a attribute with the given namespace and name.

Specified by:

hasAttrNs in class SpinXmlElement

Parameters:

namespace - the namespace of the attribute

attributeName - the name of the attribute

Returns:

true if the element has an attribute with this name under given namespace, false otherwise

attrs

public SpinList<SpinXmlAttribute> attrs()

Description copied from class: SpinXmlElement

Returns all wrapped attributes of this element.

Specified by:

attrs in class SpinXmlElement

Returns:

the wrapped attributes or an empty list of no attributes are found

attrs

public SpinList<SpinXmlAttribute> attrs(String namespace)

Description copied from class: SpinXmlElement

Returns all wrapped attributes for the given namespace.

Specified by:

attrs in class SpinXmlElement

Parameters:

namespace - the namespace of the attributes

Returns:

the wrapped attributes or an empty list of no attributes are found

attrNames

public List<String> attrNames()

Description copied from class: SpinXmlElement

Returns all names of the attributes of this element.

Specified by:

attrNames in class SpinXmlElement

Returns:

the names of the attributes

attrNames

public List<String> attrNames(String namespace)

Description copied from class: SpinXmlElement

Returns all names of the attributes in the given namespace.

Specified by:

attrNames in class SpinXmlElement

Returns:

the names of the attributes

textContent

public String textContent()

Description copied from class: SpinXmlElement

Returns the text content of an element.

Specified by:

textContent in class SpinXmlElement

Returns:

the text content or an empty string if non exists

textContent

public SpinXmlElement textContent(String textContent)

Description copied from class: SpinXmlElement

Sets the text content of an element.

Specified by:

textContent in class SpinXmlElement

Parameters:

textContent - the text content to set

Returns:

the wrapped element

childElement

public SpinXmlElement childElement(String elementName)

Description copied from class: SpinXmlElement

Returns a single wrapped child element for the given name in the local namespace of this element.

Specified by:

childElement in class SpinXmlElement

Parameters:

elementName - the element name

Returns:

the wrapped child element

childElement

public SpinXmlElement childElement(String namespace,
 String elementName)

Description copied from class: SpinXmlElement

Returns a single wrapped child element for the given namespace and name.

Specified by:

childElement in class SpinXmlElement

Parameters:

namespace - the namespace of the element

elementName - the element name

Returns:

the wrapped child element

childElements

public SpinList<SpinXmlElement> childElements()

Description copied from class: SpinXmlElement

Returns all child elements of this elements.

Specified by:

childElements in class SpinXmlElement

Returns:

list of wrapped child elements

childElements

public SpinList<SpinXmlElement> childElements(String elementName)

Description copied from class: SpinXmlElement

Returns all child elements with a given name in the local namespace of this element.

Specified by:

childElements in class SpinXmlElement

Parameters:

elementName - the element name

Returns:

a collection of wrapped elements

childElements

public SpinList<SpinXmlElement> childElements(String namespace,
 String elementName)

Description copied from class: SpinXmlElement

Returns all child elements with a given namespace and name.

Specified by:

childElements in class SpinXmlElement

Parameters:

namespace - the namespace of the element

elementName - the element name

Returns:

a collection of wrapped elements

attr

public SpinXmlElement attr(String attributeName,
 String value)

Description copied from class: SpinXmlElement

Sets the attribute value in the local namespace of this element.

Specified by:

attr in class SpinXmlElement

Parameters:

attributeName - the name of the attribute

value - the value to set

Returns:

the wrapped element

attrNs

public SpinXmlElement attrNs(String namespace,
 String attributeName,
 String value)

Description copied from class: SpinXmlElement

Sets the attribute value in the given namespace.

Specified by:

attrNs in class SpinXmlElement

Parameters:

namespace - the namespace of the attribute

attributeName - the name of the attribute

value - the value to set

Returns:

the wrapped element

removeAttr

public SpinXmlElement removeAttr(String attributeName)

Description copied from class: SpinXmlElement

Removes the attribute with an empty namespace.

Specified by:

removeAttr in class SpinXmlElement

Parameters:

attributeName - the name of the attribute

Returns:

the wrapped element

removeAttrNs

public SpinXmlElement removeAttrNs(String namespace,
 String attributeName)

Description copied from class: SpinXmlElement

Removes the attribute under the given namespace.

Specified by:

removeAttrNs in class SpinXmlElement

Parameters:

namespace - the namespace of the attribute

attributeName - the name of the attribute

Returns:

the wrapped element

append

public SpinXmlElement append(SpinXmlElement... childElements)

Description copied from class: SpinXmlElement

Appends child elements to this element.

Specified by:

append in class SpinXmlElement

Parameters:

childElements - the child elements to append

Returns:

the wrapped element

append

public SpinXmlElement append(SpinXmlElement childElement)

append

public SpinXmlElement append(Collection<SpinXmlElement> childElements)

Description copied from class: SpinXmlElement

Appends child elements to this element.

Specified by:

append in class SpinXmlElement

Parameters:

childElements - the child elements to append

Returns:

the wrapped element

appendBefore

public SpinXmlElement appendBefore(SpinXmlElement childElement,
 SpinXmlElement existingChildElement)

Description copied from class: SpinXmlElement

Appends a child element to this element before the existing child element.

Specified by:

appendBefore in class SpinXmlElement

Parameters:

childElement - the child element to append

existingChildElement - the child element to append before

Returns:

the wrapped element

appendAfter

public SpinXmlElement appendAfter(SpinXmlElement childElement,
 SpinXmlElement existingChildElement)

Description copied from class: SpinXmlElement

Appends a child element to this element after the existing child element.

Specified by:

appendAfter in class SpinXmlElement

Parameters:

childElement - the child element to append

existingChildElement - the child element to append after

Returns:

the wrapped element

remove

public SpinXmlElement remove(SpinXmlElement... childElements)

Description copied from class: SpinXmlElement

Removes all child elements from this element.

Specified by:

remove in class SpinXmlElement

Parameters:

childElements - the child elements to remove

Returns:

the wrapped element

remove

public SpinXmlElement remove(SpinXmlElement childElement)

remove

public SpinXmlElement remove(Collection<SpinXmlElement> childElements)

Description copied from class: SpinXmlElement

Removes all child elements from this element.

Specified by:

remove in class SpinXmlElement

Parameters:

childElements - the child elements to remove

Returns:

the wrapped element

replace

public SpinXmlElement replace(SpinXmlElement newElement)

Description copied from class: SpinXmlElement

Replaces this element by an new one.

Specified by:

replace in class SpinXmlElement

Parameters:

newElement - the new element

Returns:

the new wrapped element

replaceChild

public SpinXmlElement replaceChild(SpinXmlElement existingChildElement,
 SpinXmlElement newChildElement)

Description copied from class: SpinXmlElement

Replaces an existing child element with a new one.

Specified by:

replaceChild in class SpinXmlElement

Parameters:

existingChildElement - the existing child element to replace

newChildElement - the new child element

Returns:

the wrapped element

xPath

public SpinXPathQuery xPath(String expression)

Description copied from class: SpinXmlElement

Creates a XPath query on this element.

Specified by:

xPath in class SpinXmlElement

Parameters:

expression - the XPath expression

Returns:

the XPath query

adoptElement

protected void adoptElement(DomXmlElement elementToAdopt)

Adopts an xml dom element to the owner document of this element if necessary.

Parameters:

elementToAdopt - the element to adopt

toString

public String toString()

Description copied from class: SpinXmlElement

Returns the wrapped XML element as string representation.

Specified by:

toString in class SpinXmlElement

Returns:

the string representation

writeToWriter

public void writeToWriter(Writer writer)

Description copied from class: SpinXmlElement

Writes the wrapped XML element to a existing writer.

Specified by:

writeToWriter in class SpinXmlElement

Parameters:

writer - the writer to write to

getXPathFactory

protected XPathFactory getXPathFactory()

Returns a XPath Factory

Returns:

the XPath factory

mapTo

public <C> C mapTo(Class<C> javaClass)

Description copied from class: SpinXmlNode

Maps XML into specific class

Specified by:

mapTo in class SpinXmlNode<SpinXmlElement>

Parameters:

javaClass - Class to which the Xml should be mapped

Returns:

mapped Class

mapTo

public <C> C mapTo(String javaClass)

Description copied from class: SpinXmlNode

Maps Xml into specific class

Specified by:

mapTo in class SpinXmlNode<SpinXmlElement>

Parameters:

javaClass - canonical name of the class

Returns:

mapped class