org.openxml.dom

Class ElementImpl

java.lang.Object

org.openxml.dom.NodeImpl

org.openxml.dom.ParentNodeImpl

org.openxml.dom.ParentNSNodeImpl

org.openxml.dom.ElementImpl

All Implemented Interfaces:

Cloneable, Element, Node

Direct Known Subclasses:

HTMLElementImpl

public class ElementImpl
extends ParentNSNodeImpl
implements Element

The most common node type, Element inherits the generic Node interface and adds support for retrieving and setting attributes either as nodes or as strings.

Notes:

1. Node type is Node.ELEMENT_NODE
2. Node supports childern
3. Node has no value
4. Node has attributes

To speed up implementation, all attributes are implemented as double-linked list implemented using _parent, _nextNode and _prevNode. This support is provided to through appendAttr and removeAttr methods.

Author:

Assaf Arkin

See Also:

Element, Attr, NamedNodeMap, AttrImpl

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

Constructor and Description
ElementImpl(DocumentImpl owner, String namespaceURI, String qualifiedName) Constructor requires only owner document, optional namespace URI and qualified name.

Method Summary

Modifier and Type	Method and Description
Object	clone()
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.
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
boolean	equals(Object other) Returns true if this node and other are identical by content but not context.
String	getAttribute(String name)
Attr	getAttributeNode(String name)
Attr	getAttributeNodeNS(String namespaceURI, String localName)
String	getAttributeNS(String namespaceURI, String localName)
NamedNodeMap	getAttributes() Return attributes of node.
String	getBaseURI()
NodeList	getElementsByTagName(String tagName) Returns a list of elements extracted based on their tag name (or all of them if the tag name is "*").
NodeList	getElementsByTagNameNS(String namespaceURI, String localName)
Object	getFeature(String feature, String version)
short	getNodeType() Abstract method must be implemented by each node class.
TypeInfo	getSchemaTypeInfo()
String	getTagName() Returns the name of the tag, same as calling NodeImpl.getNodeName().
String	getTextContent()
Object	getUserData(String key)
boolean	hasAttribute(String name) Introduced in DOM Level 2.
boolean	hasAttributeNS(String namespaceURI, String localName) Introduced in DOM Level 2.
boolean	hasAttributes()
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	normalize()
void	removeAttribute(String name)
Attr	removeAttributeNode(Attr oldAttr)
void	removeAttributeNS(String namespaceURI, String localName)
void	setAttribute(String name, String value)
Attr	setAttributeNode(Attr newAttr)
Attr	setAttributeNodeNS(Attr newAttr)
void	setAttributeNS(String namespaceURI, String localName, String value)
void	setIdAttribute(String name, boolean isId)
void	setIdAttributeNode(Attr idAttr, boolean isId)
void	setIdAttributeNS(String namespaceURI, String localName, boolean isId)
void	setNodeValue(String value) Changes the value of the node.
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
String	toString()

Methods inherited from class org.openxml.dom.ParentNSNodeImpl

getLocalName, getNamespaceURI, getPrefix, setPrefix

Methods inherited from class org.openxml.dom.ParentNodeImpl

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

Methods inherited from class org.openxml.dom.NodeImpl

getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, isReadOnly, makeReadOnly, setOwnerDocument, supports

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, removeChild, replaceChild, setPrefix

Constructor Detail

ElementImpl

public ElementImpl(DocumentImpl owner,
                   String namespaceURI,
                   String qualifiedName)

Constructor requires only owner document, optional namespace URI and qualified name. HTML documents.

Parameters:

owner - Owner document of this element

namespaceURI - The namespace URI, or null

qualifiedName - The qualified name of this element

Method Detail

getNodeType

public final short getNodeType()

Description copied from class: NodeImpl

Abstract method must be implemented by each node class.

Specified by:

getNodeType in interface Node

Specified by:

getNodeType in class NodeImpl

See Also:

Node.getNodeType()

getTagName

public final String getTagName()

Returns the name of the tag, same as calling NodeImpl.getNodeName(). In XML documents, the return value preserves case. In HTML documents, the return value is always upper case regardless of the original value.

Specified by:

getTagName in interface Element

Returns:

Tag name

setNodeValue

public final void setNodeValue(String value)

Description copied from class: NodeImpl

Changes the value of the node. Not all node types support the notion of a value. If the value is not supported by a particular node type, it will throw an exception when calling this method. The following table specifies which node types support values:

 Element                Not supported
 Attr                   Supported
 Text                   Supported
 CDATASection           Supported
 EntityReference        Not supported
 Entity                 Not supported
 ProcessingInstruction  Supported
 Comment                Supported
 Document               Not supported
 DocumentType           Not supported
 DocumentFragment       Not supported
 Notation               Not supported
 

For most node types, if the value is set to null, NodeImpl.getNodeValue() will return an empty string instead.

Specified by:

setNodeValue in interface Node

Overrides:

setNodeValue in class NodeImpl

Parameters:

value - New value of node

getElementsByTagName

public NodeList getElementsByTagName(String tagName)

Returns a list of elements extracted based on their tag name (or all of them if the tag name is "*"). The returned list is a snapshot of the element's contents at the time of calling. Subsequent updates to the element are not reflected in the list. This might result in inaccuracies when working from multiple threads.

Specified by:

getElementsByTagName in interface Element

Parameters:

tagName - The element tag name to look for or "*" for all elements

Returns:

A snapshot of the named elements contained within this element

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

Specified by:

getElementsByTagNameNS in interface Element

getAttributes

public final NamedNodeMap getAttributes()

Description copied from class: NodeImpl

Return attributes of node. Returns null unless node is of type Element, in which case the returned NamedNodeMap will provide access to all the element's attributes.

Specified by:

getAttributes in interface Node

Overrides:

getAttributes in class NodeImpl

Returns:

Attributes of node or null

getAttribute

public String getAttribute(String name)

Specified by:

getAttribute in interface Element

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)

Specified by:

getAttributeNS in interface Element

setAttribute

public final void setAttribute(String name,
                               String value)

Specified by:

setAttribute in interface Element

setAttributeNS

public final void setAttributeNS(String namespaceURI,
                                 String localName,
                                 String value)
                          throws DOMException

Specified by:

setAttributeNS in interface Element

Throws:

DOMException

removeAttributeNS

public final void removeAttributeNS(String namespaceURI,
                                    String localName)

Specified by:

removeAttributeNS in interface Element

removeAttribute

public final void removeAttribute(String name)

Specified by:

removeAttribute in interface Element

getAttributeNode

public Attr getAttributeNode(String name)

Specified by:

getAttributeNode in interface Element

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String localName)

Specified by:

getAttributeNodeNS in interface Element

setAttributeNode

public final Attr setAttributeNode(Attr newAttr)
                            throws DOMException

Specified by:

setAttributeNode in interface Element

Throws:

DOMException

setAttributeNodeNS

public final Attr setAttributeNodeNS(Attr newAttr)
                              throws DOMException

Specified by:

setAttributeNodeNS in interface Element

Throws:

DOMException

removeAttributeNode

public final Attr removeAttributeNode(Attr oldAttr)

Specified by:

removeAttributeNode in interface Element

normalize

public final void normalize()

Specified by:

normalize in interface Node

Overrides:

normalize in class ParentNodeImpl

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 ParentNSNodeImpl

Parameters:

other - The other node to test for equality

Returns:

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

clone

public Object clone()

Overrides:

clone in class Object

cloneNode

public Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

toString

public String toString()

Overrides:

toString in class Object

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 ParentNSNodeImpl

Parameters:

into - A node into which to duplicate this one

deep - True if deep cloning is required

hasAttribute

public boolean hasAttribute(String name)

Introduced in DOM Level 2.

Specified by:

hasAttribute in interface Element

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                              String localName)

Introduced in DOM Level 2.

Specified by:

hasAttributeNS in interface Element

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface Element

setIdAttribute

public void setIdAttribute(String name,
                           boolean isId)
                    throws DOMException

Specified by:

setIdAttribute in interface Element

Throws:

DOMException

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
                             String localName,
                             boolean isId)
                      throws DOMException

Specified by:

setIdAttributeNS in interface Element

Throws:

DOMException

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr,
                               boolean isId)
                        throws DOMException

Specified by:

setIdAttributeNode in interface Element

Throws:

DOMException

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

getFeature

public Object getFeature(String feature,
                         String version)

Specified by:

getFeature in interface Node

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

Specified by:

setUserData in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

isSupported

public boolean isSupported(String feature,
                           String version)

Specified by:

isSupported in interface Node