org.xmlbeam.util.intern

Class DOMHelper

java.lang.Object

org.xmlbeam.util.intern.DOMHelper

public final class DOMHelper
extends Object

A set of tiny helper methods internally used in the projection framework. This methods are not part of the public framework API and might change in minor version updates.

Author:

Sven Ewald

Constructor Summary

Constructors

Constructor and Description
DOMHelper()

Method Summary

Modifier and Type	Method and Description
static void	appendClone(Element parentElement, Node o)
static <T> List<T>	asList(T node)
static void	ensureOwnership(Document ownerDocument, Node node)
static Map<String,String>	getNamespaceMapping(Document document) Parse namespace prefixes defined in the documents root element.
static Document	getOwnerDocumentFor(Node documentOrElement)
static int	nodeHashCode(Node node) hashCode() implementation that is compatible with equals().
static boolean	nodesAreEqual(Node a, Node b) Implementation independent version of the Node.isEqualNode() method.
static void	removeAllChildren(Element element) Simply removes all child nodes.
static void	removeAttribute(Attr attributeNode)
static void	removeNodes(Iterable<? extends Node> existingNodes)
static Element	renameElement(Element element, String newName)
static void	replaceElement(Element previous, Element newNode)
static void	setDocumentElement(Document document, Element element) Replace the current root element.
static void	setOrRemoveAttribute(Element element, String attributeName, String value)
static void	setStringValue(Node newNode, String value) Set a text value to a node whether it is an element or an attribute.
static String	toXMLString(XBProjector projector, Node domNode)
static void	trim(Node domNode)

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMHelper

public DOMHelper()

Method Detail

getNamespaceMapping

public static Map<String,String> getNamespaceMapping(Document document)

Parse namespace prefixes defined in the documents root element.

Parameters:

document - source document.

Returns:

map with prefix->uri relationships.

setDocumentElement

public static void setDocumentElement(Document document,
                                      Element element)

Replace the current root element. If element is null, the current root element will be removed.

Parameters:

document -

element -

nodesAreEqual

public static boolean nodesAreEqual(Node a,
                                    Node b)

Implementation independent version of the Node.isEqualNode() method. Matches the same algorithm as the nodeHashCode method.
Two nodes are equal if and only if the following conditions are satisfied:

• The two nodes are of the same type.
• The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue . This is: they are both null, or they have the same length and are character for character identical.
• The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.
• The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.

For two DocumentType nodes to be equal, the following conditions must also be satisfied:

• The following string attributes are equal: publicId, systemId, internalSubset.
• The entities NamedNodeMaps are equal.
• The notations NamedNodeMaps are equal.

Parameters:

a -

b -

Returns:

true if and only if the nodes are equal in the manner explained above

nodeHashCode

public static int nodeHashCode(Node node)

hashCode() implementation that is compatible with equals().

Parameters:

node -

Returns:

hash code for node

setOrRemoveAttribute

public static void setOrRemoveAttribute(Element element,
                                        String attributeName,
                                        String value)

Parameters:

element -

attributeName -

value -

renameElement

public static Element renameElement(Element element,
                                    String newName)

Parameters:

element -

newName -

Returns:

a new Element instance with desired name and content.

ensureOwnership

public static void ensureOwnership(Document ownerDocument,
                                   Node node)

Parameters:

ownerDocument -

node -

getOwnerDocumentFor

public static Document getOwnerDocumentFor(Node documentOrElement)

Parameters:

documentOrElement -

Returns:

document that owns the given node

trim

public static void trim(Node domNode)

Parameters:

domNode -

asList

public static <T> List<T> asList(T node)

Parameters:

node -

Returns:

either a List with this node, or an empty list if node is null.

replaceElement

public static void replaceElement(Element previous,
                                  Element newNode)

Parameters:

previous -

newNode -

setStringValue

public static void setStringValue(Node newNode,
                                  String value)

Set a text value to a node whether it is an element or an attribute.

Parameters:

newNode -

value -

removeAllChildren

public static void removeAllChildren(Element element)

Simply removes all child nodes.

Parameters:

element -

removeAttribute

public static void removeAttribute(Attr attributeNode)

Parameters:

attributeNode -

appendClone

public static void appendClone(Element parentElement,
                               Node o)

Parameters:

parentElement -

o -

removeNodes

public static void removeNodes(Iterable<? extends Node> existingNodes)

Parameters:

existingNodes -

toXMLString

public static String toXMLString(XBProjector projector,
                                 Node domNode)

Parameters:

projector -

domNode -

Returns:

rendered XML as String