com.hp.hpl.thermopylae
Class AttrImpl

java.lang.Object
  |
  +--com.hp.hpl.thermopylae.AttrImpl
All Implemented Interfaces:
org.w3c.dom.Attr, org.w3c.dom.Node

public class AttrImpl
extends java.lang.Object
implements org.w3c.dom.Attr

Wrapper around sparta attribute.

Copyright (C) 2002 Hewlett-Packard Company. This file is part of Sparta, an XML Parser, DOM, and XPath library. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Version:
$Date: 2002/08/19 05:04:19 $ $Revision: 1.1.1.1 $
Author:
Eamonn O'Brien-Strain

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, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE
 
Method Summary
 org.w3c.dom.Node appendChild(org.w3c.dom.Node parm1)
          Adds the node newChild to the end of the list of children of this node.
 org.w3c.dom.Node cloneNode(boolean parm1)
          Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
 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.
 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()
          The absolute base URI of this node or null if undefined.
 org.w3c.dom.NodeList getChildNodes()
          A NodeList that contains all children of this node.
 org.w3c.dom.Node getFirstChild()
          The first child of this node.
 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.
 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 getName()
          Returns the name of this attribute.
 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 the table above.
 short getNodeType()
          A code representing the type of the underlying object, as defined above.
 java.lang.String getNodeValue()
          The 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.Element getOwnerElement()
          The Element node this attribute is attached to or null if this attribute is not in use.
 org.w3c.dom.Node getParentNode()
          The parent of this node.
 java.lang.String getPrefix()
          The namespace prefix of this node, or null if it is unspecified.
 org.w3c.dom.Node getPreviousSibling()
          The node immediately preceding this node.
 boolean getSpecified()
          If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false.
 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.
 java.lang.String getValue()
          On retrieval, the value of the attribute is returned as a string.
 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 parm1, org.w3c.dom.Node parm2)
          Inserts the node newChild before the existing child node refChild.
 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.
 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 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 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 parm1)
          Removes the child node indicated by oldChild from the list of children, and returns it.
 org.w3c.dom.Node replaceChild(org.w3c.dom.Node parm1, org.w3c.dom.Node parm2)
          Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
 void setNodeValue(java.lang.String parm1)
          The value of this node, depending on its type; see the table above.
 void setPrefix(java.lang.String parm1)
          The namespace prefix of this node, or null if it is unspecified.
 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, org.w3c.dom.UserDataHandler handler)
          Associate an object to a key on this node.
 void setValue(java.lang.String parm1)
          On retrieval, the value of the attribute is returned as a string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getName

public java.lang.String getName()
Description copied from interface: org.w3c.dom.Attr
Returns the name of this attribute.
Specified by:
getName in interface org.w3c.dom.Attr

getOwnerElement

public org.w3c.dom.Element getOwnerElement()
Description copied from interface: org.w3c.dom.Attr
The Element node this attribute is attached to or null if this attribute is not in use.
This attribute represents the property [owner element] defined in .
Specified by:
getOwnerElement in interface org.w3c.dom.Attr

getSpecified

public boolean getSpecified()
Description copied from interface: org.w3c.dom.Attr
If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false. Note that the implementation is in charge of this attribute, not the user. If the user changes the value of the attribute (even if it ends up having the same value as the default value) then the specified flag is automatically flipped to true. To re-specify the attribute as the default value from the DTD, the user must delete the attribute. The implementation will then make a new attribute available with specified set to false and the default value (if one exists).
In summary: If the attribute has an assigned value in the document then specified is true, and the value is the assigned value.If the attribute has no assigned value in the document and has a default value in the DTD, then specified is false, and the value is the default value in the DTD.If the attribute has no assigned value in the document and has a value of #IMPLIED in the DTD, then the attribute does not appear in the structure model of the document.If the ownerElement attribute is null (i.e. because it was just created or was set to null by the various removal and cloning operations) specified is true.
This attribute represents the property [specified] defined .
Specified by:
getSpecified in interface org.w3c.dom.Attr

getValue

public java.lang.String getValue()
Description copied from interface: org.w3c.dom.Attr
On retrieval, the value of the attribute is returned as a string. Character and general entity references are replaced with their values. See also the method getAttribute on the Element interface.
On setting, this creates a Text node with the unparsed contents of the string. I.e. any characters that an XML processor would recognize as markup are instead treated as literal text. See also the method setAttribute on the Element interface.
If the value does contain the normalized attribute value, this attribute represents the property [normalized value] defined in .
Specified by:
getValue in interface org.w3c.dom.Attr
Following copied from interface: org.w3c.dom.Attr
Throws:
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

setValue

public void setValue(java.lang.String parm1)
              throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Attr
On retrieval, the value of the attribute is returned as a string. Character and general entity references are replaced with their values. See also the method getAttribute on the Element interface.
On setting, this creates a Text node with the unparsed contents of the string. I.e. any characters that an XML processor would recognize as markup are instead treated as literal text. See also the method setAttribute on the Element interface.
If the value does contain the normalized attribute value, this attribute represents the property [normalized value] defined in .
Specified by:
setValue in interface org.w3c.dom.Attr
Following copied from interface: org.w3c.dom.Attr
Throws:
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node parm1)
                             throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
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
Following copied from 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 readonly or if the previous parent of the node being inserted is readonly.

cloneNode

public org.w3c.dom.Node cloneNode(boolean parm1)
Description copied from interface: org.w3c.dom.Node
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.) and no user data. User data associated to the imported node is not carried over. However, if any UserDataHandlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
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 children it contains unless it is a deep clone. This includes text contained in an the Element 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 an Attribute always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning an EntityReference automatically constructs its subtree if a corresponding Entity is available, no matter whether this is a deep clone or not. 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
Following copied from 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.

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()
Description copied from interface: org.w3c.dom.Node
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
If no namespace declaration appear in the attributes, this attribute represents the property [attributes] defined in .
Specified by:
getAttributes in interface org.w3c.dom.Node

getChildNodes

public org.w3c.dom.NodeList getChildNodes()
Description copied from interface: org.w3c.dom.Node
A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
When the node is a Document, or an Element, and if the NodeList does not contain EntityReference or CDATASection nodes, this attribute represents the properties [children] defined in .
Specified by:
getChildNodes in interface org.w3c.dom.Node

getFirstChild

public org.w3c.dom.Node getFirstChild()
Description copied from interface: org.w3c.dom.Node
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()
Description copied from interface: org.w3c.dom.Node
The last child of this node. If there is no such node, this returns null.
Specified by:
getLastChild in interface org.w3c.dom.Node

getLocalName

public java.lang.String getLocalName()
Description copied from interface: org.w3c.dom.Node
Returns the local part of the qualified name of this node.
When the node is Element, or Attr, this attribute represents the properties [local name] defined in .
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

getNamespaceURI

public java.lang.String getNamespaceURI()
Description copied from interface: org.w3c.dom.Node
The namespace URI of this node, or null if it is unspecified.
When the node is Element, or Attr, this attribute represents the properties [namespace name] defined in .
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

getNextSibling

public org.w3c.dom.Node getNextSibling()
Description copied from interface: org.w3c.dom.Node
The node immediately following this node. If there is no such node, this returns null.
Specified by:
getNextSibling in interface org.w3c.dom.Node

getNodeName

public java.lang.String getNodeName()
Description copied from interface: org.w3c.dom.Node
The name of this node, depending on its type; see the table above.
Specified by:
getNodeName in interface org.w3c.dom.Node

getNodeType

public short getNodeType()
Description copied from interface: org.w3c.dom.Node
A code representing the type of the underlying object, as defined above.
Specified by:
getNodeType in interface org.w3c.dom.Node

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
The 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
Following copied from 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.

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()
Description copied from interface: org.w3c.dom.Node
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

getParentNode

public org.w3c.dom.Node getParentNode()
Description copied from interface: org.w3c.dom.Node
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.
When the node is an Element, a ProcessingInstruction, an EntityReference, a CharacterData, a Comment, or a DocumentType, this attribute represents the properties [parent] defined in .
Specified by:
getParentNode in interface org.w3c.dom.Node

getPrefix

public java.lang.String getPrefix()
Description copied from interface: org.w3c.dom.Node
The namespace prefix of this node, or null if it is unspecified.
When the node is Element, or Attr, this attribute represents the properties [prefix] defined in .
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
Following copied from 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 readonly.
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" .

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()
Description copied from interface: org.w3c.dom.Node
The node immediately preceding this node. If there is no such node, this returns null.
Specified by:
getPreviousSibling in interface org.w3c.dom.Node

hasAttributes

public boolean hasAttributes()
Description copied from interface: org.w3c.dom.Node
Returns whether this node (if it is an element) has any attributes.
Specified by:
hasAttributes in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
Returns:
true if this node has any attributes, false otherwise.

hasChildNodes

public boolean hasChildNodes()
Description copied from interface: org.w3c.dom.Node
Returns whether this node has any children.
Specified by:
hasChildNodes in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
Returns:
true if this node has any children, false otherwise.

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node parm1,
                                     org.w3c.dom.Node parm2)
                              throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
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
Following copied from 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, or if this node if of type Document and the DOM application attempts to insert a second DocumentType or Element node.
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 readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node if of type Document, this exception might be raised if the DOM implementation doesn't support the insertion of a DocumentType or Element node.

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)
Description copied from interface: org.w3c.dom.Node
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
Following copied from 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.

normalize

public void normalize()
Description copied from interface: org.w3c.dom.Node
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

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node parm1)
                             throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
Removes the child node indicated by oldChild from the list of children, and returns it.
Specified by:
removeChild in interface org.w3c.dom.Node
Following copied from 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 readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node if of type Document, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or the Element child.

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node parm1,
                                     org.w3c.dom.Node parm2)
                              throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
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
Following copied from 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 readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node if of type Document, this exception might be raised if the DOM implementation doesn't support the replacement of the DocumentType child or Element child.

setNodeValue

public void setNodeValue(java.lang.String parm1)
                  throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
The 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
Following copied from 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.

setPrefix

public void setPrefix(java.lang.String parm1)
               throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
The namespace prefix of this node, or null if it is unspecified.
When the node is Element, or Attr, this attribute represents the properties [prefix] defined in .
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
Following copied from 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 readonly.
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" .

getBaseURI

public java.lang.String getBaseURI()
Description copied from interface: org.w3c.dom.Node
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)
Specified by:
getBaseURI in interface org.w3c.dom.Node

compareTreePosition

public short compareTreePosition(org.w3c.dom.Node other)
Description copied from interface: org.w3c.dom.Node
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.
Specified by:
compareTreePosition in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
Parameters:
other - The node to compare against this node.
Returns:
Returns how the given node is positioned relatively to this node.

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
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.
Specified by:
getTextContent in interface org.w3c.dom.Node
Following copied from 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.

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Node
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.
Specified by:
setTextContent in interface org.w3c.dom.Node
Following copied from 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.

isSameNode

public boolean isSameNode(org.w3c.dom.Node other)
Description copied from interface: org.w3c.dom.Node
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.
Specified by:
isSameNode in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
Parameters:
other - The node to test against.
Returns:
Returns true if the nodes are the same, false otherwise.

lookupNamespacePrefix

public java.lang.String lookupNamespacePrefix(java.lang.String namespaceURI)
Description copied from interface: org.w3c.dom.Node
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 .
Specified by:
lookupNamespacePrefix in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
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.

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)
Description copied from interface: org.w3c.dom.Node
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 .
Specified by:
lookupNamespaceURI in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
Parameters:
prefix - The prefix to look for.
Returns:
Returns the associated namespace URI or null if none is found.

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node arg,
                           boolean deep)
Description copied from interface: org.w3c.dom.Node
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.
Specified by:
isEqualNode in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
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.

getInterface

public org.w3c.dom.Node getInterface(java.lang.String feature)
Description copied from interface: org.w3c.dom.Node
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.
Specified by:
getInterface in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
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.

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.UserDataHandler handler)
Description copied from interface: org.w3c.dom.Node
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.
Specified by:
setUserData in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
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 DOMKeyObject previously associated to the given key on this node, or null if there was none.

getUserData

public java.lang.Object getUserData(java.lang.String key)
Description copied from interface: org.w3c.dom.Node
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.
Specified by:
getUserData in interface org.w3c.dom.Node
Following copied from interface: org.w3c.dom.Node
Parameters:
key - The key the object is associated to.
Returns:
Returns the DOMKeyObject associated to the given key on this node, or null if there was none.