org.apache.xerces.dom3
Interface Node3

All Superinterfaces:
org.w3c.dom.Node

public interface Node3
extends org.w3c.dom.Node

The Node3 interface is an extension to the DOM Level 2 Node interface containing the DOM Level 3 additions.

See also the Document Object Model (DOM) Level 3 Core Specification.


Field Summary
static short TREE_POSITION_ANCESTOR
          The node is an ancestor of the reference node.
static short TREE_POSITION_DESCENDANT
          The node is a descendant of the reference node.
static short TREE_POSITION_DISCONNECTED
          The two nodes are disconnected, they do not have any common ancestor.
static short TREE_POSITION_EQUIVALENT
          The two nodes have an equivalent position.
static short TREE_POSITION_FOLLOWING
          The node follows the reference node.
static short TREE_POSITION_PRECEDING
          The node precedes the reference node.
static short TREE_POSITION_SAME_NODE
          The two nodes are the same.
 
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
 
Method Summary
 short compareTreePosition(org.w3c.dom.Node other)
          Compares a node with this node with regard to their position in the tree and according to the document order.
 java.lang.String getBaseURI()
          The absolute base URI of this node or null if undefined.
 org.w3c.dom.Node getInterface(java.lang.String feature)
          This method makes available a Node's specialized interface (see ).What are the relations between Node.isSupported and Node3.getInterface?Should we rename this method (and also DOMImplementation.getInterface?)?getInterface can return a node that doesn't actually support the requested interface and will lead to a cast exception.
 java.lang.String getTextContent()
          This attribute returns the text content of this node and its descendants.
 java.lang.Object getUserData(java.lang.String key)
          Retrieves the object associated to a key on a this node.
 boolean isEqualNode(org.w3c.dom.Node arg, boolean deep)
          Tests whether two nodes are equal.
 boolean isSameNode(org.w3c.dom.Node other)
          Returns whether this node is the same node as the given one.
 java.lang.String lookupNamespacePrefix(java.lang.String namespaceURI)
          Look up the prefix associated to the given namespace URI, starting from this node.
 java.lang.String lookupNamespaceURI(java.lang.String prefix)
          Look up the namespace URI associated to the given prefix, starting from this node.
 void setTextContent(java.lang.String textContent)
          This attribute returns the text content of this node and its descendants.
 java.lang.Object setUserData(java.lang.String key, java.lang.Object data, UserDataHandler handler)
          Associate an object to a key on this node.
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Field Detail

TREE_POSITION_PRECEDING

public static final short TREE_POSITION_PRECEDING
The node precedes the reference node.

TREE_POSITION_FOLLOWING

public static final short TREE_POSITION_FOLLOWING
The node follows the reference node.

TREE_POSITION_ANCESTOR

public static final short TREE_POSITION_ANCESTOR
The node is an ancestor of the reference node.

TREE_POSITION_DESCENDANT

public static final short TREE_POSITION_DESCENDANT
The node is a descendant of the reference node.

TREE_POSITION_EQUIVALENT

public static final short TREE_POSITION_EQUIVALENT
The two nodes have an equivalent position. This is the case of two attributes that have the same ownerElement, and two nodes that are the same.

TREE_POSITION_SAME_NODE

public static final short TREE_POSITION_SAME_NODE
The two nodes are the same. Two nodes that are the same have an equivalent position, though the reverse may not be true.

TREE_POSITION_DISCONNECTED

public static final short TREE_POSITION_DISCONNECTED
The two nodes are disconnected, they do not have any common ancestor. This is the case of two nodes that are not in the same document.
Method Detail

getBaseURI

public java.lang.String getBaseURI()
The absolute base URI of this node or null if undefined. This value is computed according to . However, when the Document supports the feature "HTML" , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise.
When the node is an Element, a Document or a a ProcessingInstruction, this attribute represents the properties [base URI] defined in . When the node is a Notation, an Entity, or an EntityReference, this attribute represents the properties [declaration base URI] in the . How will this be affected by resolution of relative namespace URIs issue?It's not.Should this only be on Document, Element, ProcessingInstruction, Entity, and Notation nodes, according to the infoset? If not, what is it equal to on other nodes? Null? An empty string? I think it should be the parent's.No.Should this be read-only and computed or and actual read-write attribute?Read-only and computed (F2F 19 Jun 2000 and teleconference 30 May 2001).If the base HTML element is not yet attached to a document, does the insert change the Document.baseURI? Yes. (F2F 26 Sep 2001)
Since:
DOM Level 3

compareTreePosition

public short compareTreePosition(org.w3c.dom.Node other)
Compares a node with this node with regard to their position in the tree and according to the document order. This order can be extended by module that define additional types of nodes.Should this method be optional?No.Need reference for namespace nodes.No, instead avoid referencing them directly.
Parameters:
other - The node to compare against this node.
Returns:
Returns how the given node is positioned relatively to this node.
Since:
DOM Level 3

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException
This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type Content
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
Should any whitespace normalization be performed? MS' text property doesn't but what about "ignorable whitespace"?Does not perform any whitespace normalization and ignores "ignorable whitespace".Should this be two methods instead?No. Keep it a read write attribute.What about the name? MS uses text and innerText. text conflicts with HTML DOM.Keep the current name, MS has a different name and different semantic.Should this be optional?No.Setting the text property on a Document, Document Type, or Notation node is an error for MS. How do we expose it? Exception? Which one? (teleconference 23 May 2001) consistency with nodeValue. Remove Document from the list.
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.
Since:
DOM Level 3

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException
This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type Content
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
Should any whitespace normalization be performed? MS' text property doesn't but what about "ignorable whitespace"?Does not perform any whitespace normalization and ignores "ignorable whitespace".Should this be two methods instead?No. Keep it a read write attribute.What about the name? MS uses text and innerText. text conflicts with HTML DOM.Keep the current name, MS has a different name and different semantic.Should this be optional?No.Setting the text property on a Document, Document Type, or Notation node is an error for MS. How do we expose it? Exception? Which one? (teleconference 23 May 2001) consistency with nodeValue. Remove Document from the list.
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.
Since:
DOM Level 3

isSameNode

public boolean isSameNode(org.w3c.dom.Node other)
Returns whether this node is the same node as the given one.
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.Do we really want to make this different from equals?Yes, change name from isIdentical to isSameNode. (Telcon 4 Jul 2000).Is this really needed if we provide a unique key?Yes, because the key is only unique within a document. (F2F 2 Mar 2001).Definition of 'sameness' is needed.
Parameters:
other - The node to test against.
Returns:
Returns true if the nodes are the same, false otherwise.
Since:
DOM Level 3

lookupNamespacePrefix

public java.lang.String lookupNamespacePrefix(java.lang.String namespaceURI)
Look up the prefix associated to the given namespace URI, starting from this node.
See for details on the algorithm used by this method.Should this be optional?No.How does the lookup work? Is it based on the prefix of the nodes, the namespace declaration attributes, or a combination of both?See .
Parameters:
namespaceURI - The namespace URI to look for.
Returns:
Returns the associated namespace prefix or null if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent.
Since:
DOM Level 3

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)
Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.Name? May need to change depending on ending of the relative namespace URI reference nightmare.No need.Should this be optional?No.How does the lookup work? Is it based on the namespaceURI of the nodes, the namespace declaration attributes, or a combination of both?See .
Parameters:
prefix - The prefix to look for.
Returns:
Returns the associated namespace URI or null if none is found.
Since:
DOM Level 3

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node arg,
                           boolean deep)
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode. All nodes that are the same will also be equal, though the reverse may not be true.
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 , baseURI. 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. This is true for Attr nodes as for any other type of node. 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.
On the other hand, the following do not affect equality: the ownerDocument attribute, the specified attribute for Attr nodes, the isWhitespaceInElementContent attribute for Text nodes, as well as any user data or event listeners registered on the nodes.Should this be optional?No.
Parameters:
arg - The node to compare equality with.
deep - If true, recursively compare the subtrees; if false, compare only the nodes themselves (and its attributes, if it is an Element).
Returns:
If the nodes, and possibly subtrees are equal, true otherwise false.
Since:
DOM Level 3

getInterface

public org.w3c.dom.Node getInterface(java.lang.String feature)
This method makes available a Node's specialized interface (see ).What are the relations between Node.isSupported and Node3.getInterface?Should we rename this method (and also DOMImplementation.getInterface?)?getInterface can return a node that doesn't actually support the requested interface and will lead to a cast exception. Other solutions are returning null or throwing an exception.
Parameters:
feature - The name of the feature requested (case-insensitive).
Returns:
Returns an alternate Node which implements the specialized APIs of the specified feature, if any, or null if there is no alternate Node which implements interfaces associated with that feature. Any alternate Node returned by this method must delegate to the primary core Node and not return results inconsistent with the primary core Node such as key, attributes, childNodes, etc.
Since:
DOM Level 3

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    UserDataHandler handler)
Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.
Parameters:
key - The key to associate the object to.
data - The object to associate to the given key, or null to remove any existing association to that key.
handler - The handler to associate to that key, or null.
Returns:
Returns the DOMObject previously associated to the given key on this node, or null if there was none.
Since:
DOM Level 3

getUserData

public java.lang.Object getUserData(java.lang.String key)
Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.
Parameters:
key - The key the object is associated to.
Returns:
Returns the DOMObject associated to the given key on this node, or null if there was none.
Since:
DOM Level 3


Copyright © 1999-2002 Apache XML Project. All Rights Reserved.