org.itsnat.core.domutil

Class ItsNatDOMUtil

java.lang.Object

org.itsnat.core.domutil.ItsNatDOMUtil

public class ItsNatDOMUtil
extends java.lang.Object

This class provides methods to do frequent DOM related tasks. Most of them access DOM Element objects filtering/ignoring any other node type.

Author:

Jose Maria Arranz Santamaria

Constructor Summary

Constructors

Constructor and Description
ItsNatDOMUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static org.w3c.dom.Element	createElement(java.lang.String tagName, java.lang.String text, org.w3c.dom.Document doc) Creates a new DOM Element with the specified tag name containing a text node with the specified text.
static org.w3c.dom.Element	createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String text, org.w3c.dom.Document doc) Creates a new DOM Element with the specified namespace URI and qualified name containing a text node with the specified text.
static org.w3c.dom.Node	extractChildren(org.w3c.dom.Node parentNode) Removes and returns the content of the specified node.
static org.w3c.dom.Element	getElementById(java.lang.String id, org.w3c.dom.Node container) Returns the first element with the specified id attribute below or the same as the specified node.
static java.lang.String	getTextContent(org.w3c.dom.Element elem) Returns the string content of the text node inside the specified Element.
static boolean	isNodeInside(org.w3c.dom.Node node, org.w3c.dom.Node parentNode) Returns true if the provided node is inside the specified parentNode.
static void	removeAllChildren(org.w3c.dom.Node parentNode) Makes empty the specified node removing all child nodes.
static void	setTextContent(org.w3c.dom.Element elem, java.lang.String value) Sets the string content of the text node inside the specified Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItsNatDOMUtil

public ItsNatDOMUtil()

Method Detail

getElementById

public static org.w3c.dom.Element getElementById(java.lang.String id,
                                 org.w3c.dom.Node container)

Returns the first element with the specified id attribute below or the same as the specified node.

Use this method when several elements in the tree have the same id attribute (duplicated id) because Document.getElementById(String) returns the first one.

Parameters:

id - the id attribute value to search.

container - the top most node to search below.

Returns:

the first element object with the specified id or null if not found.

createElement

public static org.w3c.dom.Element createElement(java.lang.String tagName,
                                java.lang.String text,
                                org.w3c.dom.Document doc)

Creates a new DOM Element with the specified tag name containing a text node with the specified text.

Parameters:

tagName - the tag name of the new element.

text - the string contained by the element as a text node, if null or empty no text node is added.

doc - the document owner of the new element.

Returns:

the new element.

See Also:

createElementNS(String,String,String,Document)

createElementNS

public static org.w3c.dom.Element createElementNS(java.lang.String namespaceURI,
                                  java.lang.String qualifiedName,
                                  java.lang.String text,
                                  org.w3c.dom.Document doc)

Creates a new DOM Element with the specified namespace URI and qualified name containing a text node with the specified text.

Parameters:

namespaceURI - the namespace URI of the new element.

qualifiedName - the qualified name of the new element.

text - the string contained by the element as a text node, if null or empty no text node is added.

doc - the document owner of the new element.

Returns:

the new element.

See Also:

createElement(String,String,Document)

getTextContent

public static java.lang.String getTextContent(org.w3c.dom.Element elem)

Returns the string content of the text node inside the specified Element.

If the element contains a child node different to a text node a cast exception is thrown.

Parameters:

elem - the parent element.

Returns:

the string value of the text child node. If element is empty returns an empty String.

setTextContent

public static void setTextContent(org.w3c.dom.Element elem,
                  java.lang.String value)

Sets the string content of the text node inside the specified Element.

If the element already contains a text node, then is updated with the new value. If the new string value is null or empty the child text node is removed. If the first child node is different to a text node a cast exception is thrown.

Parameters:

elem - the parent element.

value - the new string value of the text child node.

extractChildren

public static org.w3c.dom.Node extractChildren(org.w3c.dom.Node parentNode)

Removes and returns the content of the specified node.

If the node is empty returns null. If only contains a child node returns this child node. If contains more than one child node returns a DocumentFragment with the child nodes.

Parameters:

parentNode - the node to remove the content.

Returns:

a node with the content. May be null a tree node or a DocumentFragment.

removeAllChildren

public static void removeAllChildren(org.w3c.dom.Node parentNode)

Makes empty the specified node removing all child nodes.

Parameters:

parentNode - the node to remove the content.

isNodeInside

public static boolean isNodeInside(org.w3c.dom.Node node,
                   org.w3c.dom.Node parentNode)

Returns true if the provided node is inside the specified parentNode.

Parameters:

node - the node to know whether inside parentNode subtree.

parentNode - the node to know whether it is an ancestor of node. If null the document associated to the node parameter is used.

Returns:

true if node is inside parentNode.