de.mguennewig.pobjtool
Class NodeContainer

java.lang.Object
  de.mguennewig.pobjtool.NodeContainer

All Implemented Interfaces:

org.w3c.dom.DocumentFragment, org.w3c.dom.Node

public class NodeContainer
extends java.lang.Object
implements org.w3c.dom.DocumentFragment

A special DocumentFragment which does not move added child nodes.
Eine Wrapper-Klasse um einen Vector die Funktionalität von DocumentFragment zu geben, ohne das die Knoten aus dem Dokument in das Fragment verschoben werden.

Imported from the project PG408 - Vasari at the University of Dortmund -- the chair has moved to Duisburg in the meantime.

Author:

Michael Günnewig

See Also:

PG408 - Vasari

Field Summary

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

NodeContainer(org.w3c.dom.Document doc)
Standard-Konstruktor für NodeContainer.

Method Summary

org.w3c.dom.Node	appendChild(org.w3c.dom.Node newChild) Adds the node newChild to the end of the list of children of this node.
org.w3c.dom.Node	cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
short	compareDocumentPosition(org.w3c.dom.Node other)
static org.w3c.dom.NodeList	filterNodes(org.w3c.dom.NodeList nodeList, java.lang.String tag)
static org.w3c.dom.NodeList	filterNodes(org.w3c.dom.NodeList nodeList, java.lang.String[] tags)
org.w3c.dom.NamedNodeMap	getAttributes() A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
java.lang.String	getBaseURI()
org.w3c.dom.NodeList	getChildNodes() A NodeList that contains all children of this node.
static org.w3c.dom.NodeList	getChildrenByTagName(org.w3c.dom.Element node, java.lang.String tag) Returns the ``direct'' child elements of an element node with a given name.
java.lang.Object	getFeature(java.lang.String feature, java.lang.String version)
org.w3c.dom.Node	getFirstChild() The first child of this node.
org.w3c.dom.Node	getLastChild() The last child of this node.
java.lang.String	getLocalName() Returns the local part of the qualified name of this node.
java.lang.String	getNamespaceURI() The namespace URI of this node, or null if it is unspecified.
org.w3c.dom.Node	getNextSibling() The node immediately following this node.
java.lang.String	getNodeName() The name of this node, depending on its type; see Node.
short	getNodeType() A code representing the type of the underlying object, as defined above.
java.lang.String	getNodeValue() Get value of this node, depending on its type; see the table above.
org.w3c.dom.Document	getOwnerDocument() The Document object associated with this node.
org.w3c.dom.Node	getParentNode() The parent of this node.
java.lang.String	getPrefix() Get namespace prefix of this node, or null if it is unspecified.
org.w3c.dom.Node	getPreviousSibling() The node immediately preceding this node.
java.lang.String	getTextContent()
java.lang.Object	getUserData(java.lang.String key)
boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
boolean	hasChildNodes() Returns whether this node has any children.
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) Inserts the node newChild before the existing child node refChild.
boolean	isDefaultNamespace(java.lang.String namespaceURI)
boolean	isEqualNode(org.w3c.dom.Node arg)
boolean	isSameNode(org.w3c.dom.Node other)
boolean	isSupported(java.lang.String feature, java.lang.String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
java.lang.String	lookupNamespaceURI(java.lang.String prefix)
java.lang.String	lookupPrefix(java.lang.String namespaceURI)
void	normalize() Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.
org.w3c.dom.Node	removeChild(org.w3c.dom.Node oldChild) Removes the child node indicated by oldChild from the list of children, and returns it.
org.w3c.dom.Node	replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
void	setNodeValue(java.lang.String nodeValue) Sets value of this node, depending on its type; see the table above.
void	setPrefix(java.lang.String prefix) Set namespace prefix of this node, or null if it is unspecified.
void	setTextContent(java.lang.String textContent)
java.lang.Object	setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)
java.lang.String	toString() Returns a text representation of this instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NodeContainer

public NodeContainer(org.w3c.dom.Document doc)

Standard-Konstruktor für NodeContainer.

Parameters:

doc - das Vaterdokument, dem alle Kinder angehören müssen.

Method Detail

getNodeName

public java.lang.String getNodeName()

The name of this node, depending on its type; see Node.

Specified by:

getNodeName in interface org.w3c.dom.Node

getNodeValue

public java.lang.String getNodeValue()

Get value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect.

Specified by:

getNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

org.w3c.dom.DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setNodeValue

public void setNodeValue(java.lang.String nodeValue)

Sets value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect.

Specified by:

setNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is read-only.

org.w3c.dom.DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

getNodeType

public short getNodeType()

A code representing the type of the underlying object, as defined above.

Specified by:

getNodeType in interface org.w3c.dom.Node

getParentNode

public org.w3c.dom.Node getParentNode()

The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.

Specified by:

getParentNode in interface org.w3c.dom.Node

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

Specified by:

getChildNodes in interface org.w3c.dom.Node

getFirstChild

public org.w3c.dom.Node getFirstChild()

The first child of this node. If there is no such node, this returns null.

Specified by:

getFirstChild in interface org.w3c.dom.Node

getLastChild

public org.w3c.dom.Node getLastChild()

The last child of this node. If there is no such node, this returns null.

Specified by:

getLastChild in interface org.w3c.dom.Node

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

The node immediately preceding this node. If there is no such node, this returns null.
In this special implementation this returns the preceding node of the first child.

Specified by:

getPreviousSibling in interface org.w3c.dom.Node

getNextSibling

public org.w3c.dom.Node getNextSibling()

The node immediately following this node. If there is no such node, this returns null.
In this special implementation this returns the following node of the last child.

Specified by:

getNextSibling in interface org.w3c.dom.Node

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Specified by:

getAttributes in interface org.w3c.dom.Node

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

Specified by:

getOwnerDocument in interface org.w3c.dom.Node

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.

Specified by:

insertBefore in interface org.w3c.dom.Node

Parameters:

newChild - The node to insert.

refChild - The reference node, i.e., the node before which the new node must be inserted.

Returns:

The node being inserted.

Throws:

org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is read-only or if the parent of the node being inserted is read-only.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node oldChild)

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.

Specified by:

replaceChild in interface org.w3c.dom.Node

Parameters:

newChild - The new node to put in the child list.

oldChild - The node being replaced in the list.

Returns:

The node replaced.

Throws:

org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is read-only.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)

Removes the child node indicated by oldChild from the list of children, and returns it.

Specified by:

removeChild in interface org.w3c.dom.Node

Parameters:

oldChild - The node being removed.

Returns:

The node removed.

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is read-only.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)

Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.

Specified by:

appendChild in interface org.w3c.dom.Node

Parameters:

newChild - The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node

Returns:

The node added.

Throws:

org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is read-only or if the previous parent of the node being inserted is read-only.

hasChildNodes

public boolean hasChildNodes()

Returns whether this node has any children.

Specified by:

hasChildNodes in interface org.w3c.dom.Node

Returns:

true if this node has any children, false otherwise.

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent; ( parentNode is null.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning an Attribute directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute ( specified is true). Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are read-only. In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.

Specified by:

cloneNode in interface org.w3c.dom.Node

Parameters:

deep - If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Returns:

The duplicate node.

normalize

public void normalize()

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.

NOTE: We do not merge multiple Text and CDATASection also in our node list, as they belong to a different document and so might have different things between each other.

Specified by:

normalize in interface org.w3c.dom.Node

See Also:

Node.normalize()

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Specified by:

isSupported in interface org.w3c.dom.Node

Parameters:

feature - The name of the feature to test. This is the same name which can be passed to the method hasFeature on DOMImplementation.

version - This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.

Returns:

Returns true if the specified feature is supported on this node, false otherwise.

getNamespaceURI

public java.lang.String getNamespaceURI()

The namespace URI of this node, or null if it is unspecified.
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.Per the Namespaces in XML Specification an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.

Specified by:

getNamespaceURI in interface org.w3c.dom.Node

getPrefix

public java.lang.String getPrefix()

Get namespace prefix of this node, or null if it is unspecified.

For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Specified by:

getPrefix in interface org.w3c.dom.Node

setPrefix

public void setPrefix(java.lang.String prefix)

Set namespace prefix of this node, or null if it is unspecified.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Specified by:

setPrefix in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character, per the XML 1.0 specification .
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is read-only.
NAMESPACE_ERR: Raised if the specified prefix is malformed per the Namespaces in XML specification, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" .

getLocalName

public java.lang.String getLocalName()

Returns the local part of the qualified name of this node.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Specified by:

getLocalName in interface org.w3c.dom.Node

hasAttributes

public boolean hasAttributes()

Returns whether this node (if it is an element) has any attributes.

Specified by:

hasAttributes in interface org.w3c.dom.Node

Returns:

true if this node has any attributes, false otherwise.

getBaseURI

public java.lang.String getBaseURI()

Specified by:

getBaseURI in interface org.w3c.dom.Node

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node other)

Specified by:

compareDocumentPosition in interface org.w3c.dom.Node

getTextContent

public java.lang.String getTextContent()

Specified by:

getTextContent in interface org.w3c.dom.Node

setTextContent

public void setTextContent(java.lang.String textContent)

Specified by:

setTextContent in interface org.w3c.dom.Node

isSameNode

public boolean isSameNode(org.w3c.dom.Node other)

Specified by:

isSameNode in interface org.w3c.dom.Node

lookupPrefix

public java.lang.String lookupPrefix(java.lang.String namespaceURI)

Specified by:

lookupPrefix in interface org.w3c.dom.Node

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)

Specified by:

isDefaultNamespace in interface org.w3c.dom.Node

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)

Specified by:

lookupNamespaceURI in interface org.w3c.dom.Node

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node arg)

Specified by:

isEqualNode in interface org.w3c.dom.Node

getFeature

public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)

Specified by:

getFeature in interface org.w3c.dom.Node

getUserData

public java.lang.Object getUserData(java.lang.String key)

Specified by:

getUserData in interface org.w3c.dom.Node

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.UserDataHandler handler)

Specified by:

setUserData in interface org.w3c.dom.Node

toString

public java.lang.String toString()

Returns a text representation of this instance.

Overrides:

toString in class java.lang.Object

getChildrenByTagName

public static org.w3c.dom.NodeList getChildrenByTagName(org.w3c.dom.Element node,
                                                        java.lang.String tag)

Returns the ``direct'' child elements of an element node with a given name.

Parameters:

tag - An tag name or * for all element nodes.

filterNodes

public static org.w3c.dom.NodeList filterNodes(org.w3c.dom.NodeList nodeList,
                                               java.lang.String[] tags)

filterNodes

public static org.w3c.dom.NodeList filterNodes(org.w3c.dom.NodeList nodeList,
                                               java.lang.String tag)