electric.xml
Class Node

java.lang.Object
  electric.xml.Node

All Implemented Interfaces:

IDOMConstants, IXMLConstants, org.w3c.dom.Node, java.io.Serializable

Direct Known Subclasses:

Attribute, Child, Selection, XPathNamespace, XPathNode

public class Node

extends java.lang.Object

implements java.io.Serializable, org.w3c.dom.Node, IXMLConstants, IDOMConstants

Node is a Node in a doubly-linked list.

Author:

webMethods

See Also:

Serialized Form

Field Summary

NodeList	list
Node	next
Node	prev

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface electric.xml.IXMLConstants

ATTLIST_START, ATTLIST_STOP, CDATA, CDATA_START, CDATA_STOP, CLOSE_TAG, COLON, COMMENT_START, COMMENT_STOP, DOCTYPE_START, DOCTYPE_STOP, ELEMENTDECL_START, ELEMENTDECL_STOP, ENCODING, ENTITYDECL_START, ENTITYDECL_STOP, ID, ID_CASE, INSTRUCTION_START, INSTRUCTION_STOP, NEGATIVE_INFINITY, NOT_A_NUMBER, NOTATIONDECL_START, NOTATIONDECL_STOP, NULL, OPEN_TAG, POSITIVE_INFINITY, PUBLIC, SPECIALS, STANDALONE, SUBSTITUTES, SYSTEM, UNDEFINED, VERSION, XML, XML_NAMESPACE, XMLDECL_START, XMLDECL_STOP, XMLNS, XMLNS_NAMESPACE

Fields inherited from interface electric.xml.IDOMConstants

CDATA_SECTION_NAME, COMMENT_NAME, CORE, DOCUMENT_FRAGMENT_NAME, DOCUMENT_NAME, HIERARCHY_REQUEST_ERR, TEXT_NAME

Constructor Summary

Node()

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) Return a duplicate of this node, i.e., serve as a generic copy constructor for nodes.
org.w3c.dom.NamedNodeMap	getAttributes() Return a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise
org.w3c.dom.NodeList	getChildNodes() Return a NodeList that contains all children of this node.
org.w3c.dom.Node	getFirstChild() Return the first child of this node.
org.w3c.dom.Node	getLastChild() Return 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() Return the namespace URI of this node, or null if it is unspecified.
org.w3c.dom.Node	getNextSibling() Return the node immediately following this node.
Node	getNextSiblingNode() Return my next sibling, or null if I have none.
Node	getNode() Return myself.
Node	getNode(IXPath xpath)
java.lang.String	getNodeName() Return the name of this node, depending on its type.
Nodes	getNodes(IXPath xpath)
short	getNodeType() Return a code representing the type of the underlying object.
java.lang.String	getNodeValue() Return the value of this node, depending on its type.
org.w3c.dom.Document	getOwnerDocument() Return the Document object associated with this node.
org.w3c.dom.Node	getParentNode() Return the parent of this node.
java.lang.String	getPrefix() Return the namespace prefix of this node, or null if it is unspecified.
org.w3c.dom.Node	getPreviousSibling() Return the node immediately preceding this node.
Node	getPreviousSiblingNode() Return my previous sibling, or null if I have none.
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	isSupported(java.lang.String feature, java.lang.String version) Return true if this DOM implementation implements a specific feature and that feature is supported by this node.
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.
void	read(NodeReader reader)
boolean	remove() If I am in a list, remove myself and return true, otherwise return false.
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	setNextSiblingNode(Node node) Set my next sibling to be the specified node.
void	setNodeValue(java.lang.String nodeValue) Set the value of this node, depending on its type.
void	setPrefix(java.lang.String prefix) Set the namespace prefix of this node.
void	setPreviousSiblingNode(Node node) Set my previous sibling to be the specified node.
int	size()
void	write(NodeWriter writer)

Methods inherited from class java.lang.Object

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

Field Detail

list

public NodeList list

prev

public Node prev

next

public Node next

Constructor Detail

Node

public Node()

Method Detail

getNode

public Node getNode()

Return myself.

getPreviousSiblingNode

public Node getPreviousSiblingNode()

Return my previous sibling, or null if I have none.

getNextSiblingNode

public Node getNextSiblingNode()

Return my next sibling, or null if I have none.

setNextSiblingNode

public void setNextSiblingNode(Node node)

Set my next sibling to be the specified node. If the node is already a member of a list, remove it from that list.

Parameters:

node - The node to add

setPreviousSiblingNode

public void setPreviousSiblingNode(Node node)

Set my previous sibling to be the specified node. If the node is already a member of a list, remove it from that list.

Parameters:

node - The node to add

remove

public boolean remove()

If I am in a list, remove myself and return true, otherwise return false.

size

public int size()

getNodes

public Nodes getNodes(IXPath xpath)

Parameters:

xpath -

getNode

public Node getNode(IXPath xpath)

Parameters:

xpath -

read

public void read(NodeReader reader)
          throws java.io.IOException,
                 NamespaceException

Parameters:

reader -

Throws:

java.io.IOException

NamespaceException

write

public void write(NodeWriter writer)
           throws java.io.IOException

Parameters:

writer -

Throws:

java.io.IOException

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

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

hasChildNodes

public boolean hasChildNodes()

Returns whether this node has any children.

Specified by:

hasChildNodes in interface org.w3c.dom.Node

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

Return 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()

Return 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()

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

Specified by:

getLastChild in interface org.w3c.dom.Node

getParentNode

public org.w3c.dom.Node getParentNode()

Return 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

getNodeType

public short getNodeType()

Return a code representing the type of the underlying object.

Specified by:

getNodeType in interface org.w3c.dom.Node

getNodeName

public java.lang.String getNodeName()

Return the name of this node, depending on its type.

Specified by:

getNodeName in interface org.w3c.dom.Node

getNodeValue

public java.lang.String getNodeValue()

Return the value of this node, depending on its type. When it is defined to be null, setting it has no effect.

Specified by:

getNodeValue in interface org.w3c.dom.Node

setNodeValue

public void setNodeValue(java.lang.String nodeValue)

Set the value of this node, depending on its type.

Specified by:

setNodeValue in interface org.w3c.dom.Node

Parameters:

nodeValue -

getNamespaceURI

public java.lang.String getNamespaceURI()

Return 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()

Return the 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:

getPrefix in interface org.w3c.dom.Node

setPrefix

public void setPrefix(java.lang.String prefix)

Set the namespace prefix of this node.

Specified by:

setPrefix in interface org.w3c.dom.Node

Parameters:

prefix - The new namespace prefix.

getNextSibling

public org.w3c.dom.Node getNextSibling()

Return the node immediately following this node. If there is no such node, this returns null.

Specified by:

getNextSibling in interface org.w3c.dom.Node

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

Return the node immediately preceding this node. If there is no such node, this returns null.

Specified by:

getPreviousSibling in interface org.w3c.dom.Node

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

Return 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

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

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.

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.

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.

cloneNode

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

Return a duplicate of this node, i.e., serve 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 readonly. 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).

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. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used. In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

Specified by:

normalize in interface org.w3c.dom.Node

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

Return 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

isSupported

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

Return true if this 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 - 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.