org.openxml.dom

Class ParentNSNodeImpl

java.lang.Object

org.openxml.dom.NodeImpl

org.openxml.dom.ParentNodeImpl

org.openxml.dom.ParentNSNodeImpl

All Implemented Interfaces:

Cloneable, Node

Direct Known Subclasses:

AttrImpl, ElementImpl

public abstract class ParentNSNodeImpl
extends ParentNodeImpl
implements Node, Cloneable

Implements a node that has child nodes and supports namespaces. Only AttrImpl and ElementImpl require support for both child nodes and namespace handling, and only these two extend this class.

This class is abstract. All derived classes must extend NodeImpl.getNodeType(). In addition, derived classes might wish to extend Node.cloneNode(boolean), equals(java.lang.Object) and Object.toString() and other methods as necessary. Many methods cannot be extended.

This class is optimized for searching either by qualified name, namespace URI or local name. The prefix is not stored and must be calculated each time.

Author:

Assaf Arkin

See Also:

Node, ParentNodeImpl

Field Summary

Fields inherited from class org.openxml.dom.NodeImpl

ATTLIST_DECL_NODE, ELEMENT_DECL_NODE, PARAM_ENTITY_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParentNSNodeImpl(DocumentImpl owner, String namespaceURI, String qualifiedName, String value) Hidden constructor creates a new node.

Method Summary

Modifier and Type	Method and Description
protected void	cloneInto(NodeImpl into, boolean deep) This clone method is called after a new node has been constructed to copy the contents of this node into the new one.
boolean	equals(Object other) Returns true if this node and other are identical by content but not context.
String	getLocalName() Returns the local part of the qualified name of this node.
String	getNamespaceURI() Returns the namespace URI associated with this node, or null if unspecified.
String	getPrefix() Returns the namespace prefix of this node, or null if unspecified.
void	setPrefix(String newPrefix) Sets the namespace prefix of this node.

Methods inherited from class org.openxml.dom.ParentNodeImpl

appendChild, castNewChild, castOldChild, createNodeIterator, getChildNodes, getFirstChild, getLastChild, hasChildNodes, insertBefore, normalize, removeChild, removeInnerIterator, replaceChild

Methods inherited from class org.openxml.dom.NodeImpl

getAttributes, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, isReadOnly, makeReadOnly, setNodeValue, setOwnerDocument, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setTextContent, setUserData

Constructor Detail

ParentNSNodeImpl

protected ParentNSNodeImpl(DocumentImpl owner,
                           String namespaceURI,
                           String qualifiedName,
                           String value)
                    throws DOMException

Hidden constructor creates a new node. Used for creating nodes that are namespace aware.

The namespace URI is optional, the qualifiedName is checked to be a valid name with optional prefix and local name parts. If the namespace rules are violated, an exception is thrown.

Parameters:

owner - Document owner of this node, or null

namespaceURI - The namespace URI

qualifiedName - The qualified node name

value - Initial value of node or null

Throws:

DOMException - INVALID_CHARACTER_ERR Node name cannot contain whitespaces or non-printable characters and may use ':' only in compliance with namespace rules

Method Detail

getNamespaceURI

public final String getNamespaceURI()

Returns the namespace URI associated with this node, or null if unspecified. This is the namespace URI given at creation time.

Specified by:

getNamespaceURI in interface Node

Overrides:

getNamespaceURI in class NodeImpl

Returns:

The namespace URI of this node, null if unspecified

getPrefix

public final String getPrefix()

Returns the namespace prefix of this node, or null if unspecified.

Specified by:

getPrefix in interface Node

Overrides:

getPrefix in class NodeImpl

Returns:

The namespace prefix of this node, null if unspecified

setPrefix

public final void setPrefix(String newPrefix)

Sets the namespace prefix of this node. This will affect NodeImpl.getNodeName(), which holds he qualified name of the node.

Specified by:

setPrefix in interface Node

Overrides:

setPrefix in class NodeImpl

Parameters:

newPrefix - The new prefix for the qualified name, or null

getLocalName

public final String getLocalName()

Returns the local part of the qualified name of this node. If the prefix was unspecified, the returned value is equal to the node name.

Specified by:

getLocalName in interface Node

Overrides:

getLocalName in class NodeImpl

Returns:

The local part of the qualified name

cloneInto

protected void cloneInto(NodeImpl into,
                         boolean deep)

Description copied from class: NodeImpl

This clone method is called after a new node has been constructed to copy the contents of this node into the new one. It clones in contents but not in context, and guarantees that the cloned node will pass the equality test (see NodeImpl.equals(java.lang.Object)).

into must be a valid node of the exact same class as this one. deep is true if deep cloning (includes all children nodes) is to be performed. If deep is false, the clone might not pass the equality test.

Derived classes override and call this method to add per-class variable copying. This method is called by Node.cloneNode(boolean) and the default Object.clone() method.

Contents cloning duplicates the node's name and value, and its children. It does not duplicate it's context, that is, the node's parent or sibling. Initially a clone node has no parents or siblings. However, the node does belong to the same document, since all nodes must belong to some document. The cloned node is never read-only.

Overrides:

cloneInto in class ParentNodeImpl

Parameters:

into - A node into which to duplicate this one

deep - True if deep cloning is required

equals

public boolean equals(Object other)

Description copied from class: NodeImpl

Returns true if this node and other are identical by content but not context. Test by content but not context adheres to the following:

• Both nodes must be of the same type, must have the same name and value (case sensitive) and for elements, the same tag name
• For elements, both must have identical attribute list, although attributes may be specified/unspecified and in different orders
• Both nodes must have no children, or must have the exact same sequence of children; children are tested for equality by calling NodeImpl.equals(java.lang.Object) on each pair
• However, both nodes may reside in different documents, belong to different parents, have different siblings, different read-only flags, etc.

It is guaranteed that the act of cloning a node will return a second node that will pass the test of equality.

Note that for large document roots, the equality operation can be very expensive.

Overrides:

equals in class ParentNodeImpl

Parameters:

other - The other node to test for equality

Returns:

True if both nodes are equal based on their content but not their context