com.hp.hpl.thermopylae
Class DocumentImpl

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

public class DocumentImpl
extends java.lang.Object
implements org.w3c.dom.Document

Standard wrapper around sparta Document.

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/21 20:18:42 $ $Revision: 1.2 $
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 adoptNode(org.w3c.dom.Node source)
          Changes the ownerDocument of a node, its children, as well as the attached attribute nodes if there are any.
 org.w3c.dom.Node appendChild(org.w3c.dom.Node node)
          Adds the node newChild to the end of the list of children of this node.
 boolean canSetNormalizationFeature(java.lang.String name, boolean state)
          Query whether setting a feature to a specific value is supported.
 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.Attr createAttribute(java.lang.String parm1)
          Creates an Attr of the given name.
 org.w3c.dom.Attr createAttributeNS(java.lang.String parm1, java.lang.String parm2)
          Creates an attribute of the given qualified name and namespace URI.
 org.w3c.dom.CDATASection createCDATASection(java.lang.String data)
          Creates a CDATASection node whose value is the specified string.
 org.w3c.dom.Comment createComment(java.lang.String parm1)
          Creates a Comment node given the specified string.
 org.w3c.dom.DocumentFragment createDocumentFragment()
          Creates an empty DocumentFragment object.
 org.w3c.dom.Element createElement(java.lang.String tagName)
          Creates an element of the type specified.
 org.w3c.dom.Element createElementNS(java.lang.String parm1, java.lang.String parm2)
          Creates an element of the given qualified name and namespace URI.
 org.w3c.dom.EntityReference createEntityReference(java.lang.String parm1)
          Creates an EntityReference object.
 org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String a, java.lang.String b)
          Creates a ProcessingInstruction node given the specified name and data strings.
 org.w3c.dom.Text createTextNode(java.lang.String data)
          Creates a Text node given the specified string.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getActualEncoding()
          An attribute specifying the actual encoding of this document.
 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.DocumentType getDoctype()
          The Document Type Declaration (see DocumentType) associated with this document.
 org.w3c.dom.Element getDocumentElement()
          This is a convenience attribute that allows direct access to the child node that is the document element of the document.
 java.lang.String getDocumentURI()
          The location of the document or null if undefined.
 org.w3c.dom.Element getElementById(java.lang.String parm1)
          Returns the Element whose ID is given by elementId.
 org.w3c.dom.NodeList getElementsByTagName(java.lang.String parm1)
          Returns a NodeList of all the Elements with a given tag name in document order.
 org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String parm1, java.lang.String parm2)
          Returns a NodeList of all the Elements with a given local name and namespace URI in document order.
 java.lang.String getEncoding()
          An attribute specifying, as part of the XML declaration, the encoding of this document.
 org.w3c.dom.DOMErrorHandler getErrorHandler()
          This attribute allows applications to specify a DOMErrorHandler to be called in the event that an error is encountered while performing an operation on a document.
 org.w3c.dom.Node getFirstChild()
          The first child of this node.
 org.w3c.dom.DOMImplementation getImplementation()
          The DOMImplementation object that handles this document.
 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()
          Always return null
 java.lang.String getNamespaceURI()
          Always return null
 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.
 boolean getNormalizationFeature(java.lang.String name)
          Look up the value of a feature.
 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()
          The namespace prefix of this node, or null if it is unspecified.
 org.w3c.dom.Node getPreviousSibling()
          The node immediately preceding this node.
 boolean getStandalone()
          An attribute specifying, as part of the XML declaration, whether this document is standalone.
 boolean getStrictErrorChecking()
          An attribute specifying whether errors checking is enforced or not.
 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 getVersion()
          An attribute specifying, as part of the XML declaration, the version number of this document.
 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 importNode(org.w3c.dom.Node parm1, boolean parm2)
          Imports a node from another document to this document.
 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.
 void normalizeDocument()
          This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form.
 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 renameNode(org.w3c.dom.Node n, java.lang.String namespaceURI, java.lang.String name)
          Rename an existing node.
 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 setActualEncoding(java.lang.String actualEncoding)
          An attribute specifying the actual encoding of this document.
 void setDocumentURI(java.lang.String documentURI)
          The location of the document or null if undefined.
 void setEncoding(java.lang.String encoding)
          An attribute specifying, as part of the XML declaration, the encoding of this document.
 void setErrorHandler(org.w3c.dom.DOMErrorHandler errorHandler)
          This attribute allows applications to specify a DOMErrorHandler to be called in the event that an error is encountered while performing an operation on a document.
 void setNodeValue(java.lang.String parm1)
          The value of this node, depending on its type; see the table above.
 void setNormalizationFeature(java.lang.String name, boolean state)
          Set the state of a feature.Need to specify the list of features.
 void setPrefix(java.lang.String parm1)
          The namespace prefix of this node, or null if it is unspecified.
 void setStandalone(boolean standalone)
          An attribute specifying, as part of the XML declaration, whether this document is standalone.
 void setStrictErrorChecking(boolean strictErrorChecking)
          An attribute specifying whether errors checking is enforced or not.
 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 setVersion(java.lang.String version)
          An attribute specifying, as part of the XML declaration, the version number of this document.
static DocumentImpl wrapper(Document spartan)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createAttribute

public org.w3c.dom.Attr createAttribute(java.lang.String parm1)
                                 throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttributeNode method.
To create an attribute with a qualified name and namespace URI, use the createAttributeNS method.
Specified by:
createAttribute in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
name - The name of the attribute.
Returns:
A new Attr object with the nodeName attribute set to name, and localName, prefix, and namespaceURI set to null. The value of the attribute is the empty string.
Throws:
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createAttributeNS

public org.w3c.dom.Attr createAttributeNS(java.lang.String parm1,
                                          java.lang.String parm2)
                                   throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Creates an attribute of the given qualified name and namespace URI.
Per , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.
Specified by:
createAttributeNS in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
namespaceURI - The namespace URI of the attribute to create.
qualifiedName - The qualified name of the attribute to instantiate.
Returns:
A new Attr object with the following attributes:
Attribute Value
Node.nodeName qualifiedName
Node.namespaceURI namespaceURI
Node.prefix prefix, extracted from qualifiedName, or null if there is no prefix
Node.localName local name, extracted from qualifiedName
Attr.name qualifiedName
Node.nodeValue the empty string
Throws:
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace", or if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from " http://www.w3.org/2000/xmlns/".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.

createCDATASection

public org.w3c.dom.CDATASection createCDATASection(java.lang.String data)
                                            throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Creates a CDATASection node whose value is the specified string.
Specified by:
createCDATASection in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
data - The data for the CDATASection contents.
Returns:
The new CDATASection object.
Throws:
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createComment

public org.w3c.dom.Comment createComment(java.lang.String parm1)
Description copied from interface: org.w3c.dom.Document
Creates a Comment node given the specified string.
Specified by:
createComment in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
data - The data for the node.
Returns:
The new Comment object.

createDocumentFragment

public org.w3c.dom.DocumentFragment createDocumentFragment()
Description copied from interface: org.w3c.dom.Document
Creates an empty DocumentFragment object.
Specified by:
createDocumentFragment in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Returns:
A new DocumentFragment.

createElement

public org.w3c.dom.Element createElement(java.lang.String tagName)
                                  throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.
In addition, if there are known attributes with default values, Attr nodes representing them are automatically created and attached to the element.
To create an element with a qualified name and namespace URI, use the createElementNS method.
Specified by:
createElement in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
tagName - The name of the element type to instantiate. For XML, this is case-sensitive, otherwise it depends on the case-sentivity of the markup language in use. In that case, the name is mapped to the canonical form of that markup by the DOM implementation.
Returns:
A new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.
Throws:
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createElementNS

public org.w3c.dom.Element createElementNS(java.lang.String parm1,
                                           java.lang.String parm2)
                                    throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Creates an element of the given qualified name and namespace URI.
Per , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.
Specified by:
createElementNS in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
namespaceURI - The namespace URI of the element to create.
qualifiedName - The qualified name of the element type to instantiate.
Returns:
A new Element object with the following attributes:
Attribute Value
Node.nodeName qualifiedName
Node.namespaceURI namespaceURI
Node.prefix prefix, extracted from qualifiedName, or null if there is no prefix
Node.localName local name, extracted from qualifiedName
Element.tagName qualifiedName
Throws:
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" .
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.

createEntityReference

public org.w3c.dom.EntityReference createEntityReference(java.lang.String parm1)
                                                  throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node.If any descendant of the Entity node has an unbound namespace prefix, the corresponding descendant of the created EntityReference node is also unbound; (its namespaceURI is null). The DOM Level 2 does not support any mechanism to resolve namespace prefixes.
Specified by:
createEntityReference in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
name - The name of the entity to reference.
Returns:
The new EntityReference object.
Throws:
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createProcessingInstruction

public org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String a,
                                                                     java.lang.String b)
                                                              throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Creates a ProcessingInstruction node given the specified name and data strings.
Specified by:
createProcessingInstruction in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
target - The target part of the processing instruction.
data - The data for the node.
Returns:
The new ProcessingInstruction object.
Throws:
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createTextNode

public org.w3c.dom.Text createTextNode(java.lang.String data)
Description copied from interface: org.w3c.dom.Document
Creates a Text node given the specified string.
Specified by:
createTextNode in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
data - The data for the node.
Returns:
The new Text object.

getDoctype

public org.w3c.dom.DocumentType getDoctype()
Description copied from interface: org.w3c.dom.Document
The Document Type Declaration (see DocumentType) associated with this document. For HTML documents as well as XML documents without a document type declaration this returns null. The DOM Level 2 does not support editing the Document Type Declaration.
Specified by:
getDoctype in interface org.w3c.dom.Document

getDocumentElement

public org.w3c.dom.Element getDocumentElement()
Description copied from interface: org.w3c.dom.Document
This is a convenience attribute that allows direct access to the child node that is the document element of the document.
This attribute represents the property [document element] defined in .
Specified by:
getDocumentElement in interface org.w3c.dom.Document

getElementById

public org.w3c.dom.Element getElementById(java.lang.String parm1)
Description copied from interface: org.w3c.dom.Document
Returns the Element whose ID is given by elementId. If no such element exists, returns null. Behavior is not defined if more than one element has this ID. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.
Specified by:
getElementById in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
elementId - The unique id value for an element.
Returns:
The matching element.

getElementsByTagName

public org.w3c.dom.NodeList getElementsByTagName(java.lang.String parm1)
Description copied from interface: org.w3c.dom.Document
Returns a NodeList of all the Elements with a given tag name in document order.
Specified by:
getElementsByTagName in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
tagname - The name of the tag to match on. The special value "*" matches all tags. For XML, this is case-sensitive, otherwise it depends on the case-sentivity of the markup language in use.
Returns:
A new NodeList object containing all the matched Elements.

getElementsByTagNameNS

public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String parm1,
                                                   java.lang.String parm2)
Description copied from interface: org.w3c.dom.Document
Returns a NodeList of all the Elements with a given local name and namespace URI in document order.
Specified by:
getElementsByTagNameNS in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
namespaceURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces.
localName - The local name of the elements to match on. The special value "*" matches all local names.
Returns:
A new NodeList object containing all the matched Elements.

getImplementation

public org.w3c.dom.DOMImplementation getImplementation()
Description copied from interface: org.w3c.dom.Document
The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.
Specified by:
getImplementation in interface org.w3c.dom.Document

importNode

public org.w3c.dom.Node importNode(org.w3c.dom.Node parm1,
                                   boolean parm2)
                            throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Imports a node from another document to this document. The returned node has no parent; (parentNode is null). The source node is not altered or removed from the original document; this method creates a new copy of the source node.
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's nodeName and nodeType, plus the attributes related to namespaces (prefix, localName, and namespaceURI). As in the cloneNode operation, the source node is not altered. 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.
Additional information is copied as appropriate to the nodeType, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node.
ATTRIBUTE_NODE
The ownerElement attribute is set to null and the specified flag is set to true on the generated Attr. The descendants of the source Attr are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the deep parameter has no effect on Attr nodes; they always carry their children with them when imported.
DOCUMENT_FRAGMENT_NODE
If the deep option was set to true, the descendants of the source DocumentFragment are recursively imported and the resulting nodes reassembled under the imported DocumentFragment to form the corresponding subtree. Otherwise, this simply generates an empty DocumentFragment.
DOCUMENT_NODE
Document nodes cannot be imported.
DOCUMENT_TYPE_NODE
DocumentType nodes cannot be imported.
ELEMENT_NODE
Specified attribute nodes of the source element are imported, and the generated Attr nodes are attached to the generated Element. Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If the importNode deep parameter was set to true, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
ENTITY_NODE
Entity nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM.On import, the publicId, systemId, and notationName attributes are copied. If a deep import is requested, the descendants of the the source Entity are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
ENTITY_REFERENCE_NODE
Only the EntityReference itself is copied, even if a deep import is requested, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
NOTATION_NODE
Notation nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM.On import, the publicId and systemId attributes are copied. Note that the deep parameter has no effect on this type of nodes since they cannot have any children.
PROCESSING_INSTRUCTION_NODE
The imported node copies its target and data values from those of the source node.Note that the deep parameter has no effect on this type of nodes since they cannot have any children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
These three types of nodes inheriting from CharacterData copy their data and length attributes from those of the source node.Note that the deep parameter has no effect on these types of nodes since they cannot have any children.
Specified by:
importNode in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
importedNode - The node to import.
deep - If true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This has no effect on nodes that cannot have any children, and on Attr, and EntityReference nodes.
Returns:
The imported node that belongs to this Document.
Throws:
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.
INVALID_CHARACTER_ERR: Raised if one the imported names contain an illegal character. This may happen when importing an XML 1.1 element into an XML 1.0 document, for instance.

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node node)
                             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()
Always return null
Specified by:
getLocalName in interface org.w3c.dom.Node

getNamespaceURI

public java.lang.String getNamespaceURI()
Always return null
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.

adoptNode

public org.w3c.dom.Node adoptNode(org.w3c.dom.Node source)
                           throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Changes the ownerDocument of a node, its children, as well as the attached attribute nodes if there are any. If the node has a parent it is first removed from its parent child list. This effectively allows moving a subtree from one document to another. The following list describes the specifics for each type of node.
ATTRIBUTE_NODE
The ownerElement attribute is set to null and the specified flag is set to true on the adopted Attr. The descendants of the source Attr are recursively adopted.
DOCUMENT_FRAGMENT_NODE
The descendants of the source node are recursively adopted.
DOCUMENT_NODE
Document nodes cannot be adopted.
DOCUMENT_TYPE_NODE
DocumentType nodes cannot be adopted.
ELEMENT_NODE
Specified attribute nodes of the source element are adopted, and the generated Attr nodes. Default attributes are discarded, though if the document being adopted into defines default attributes for this element name, those are assigned. The descendants of the source element are recursively adopted.
ENTITY_NODE
Entity nodes cannot be adopted.
ENTITY_REFERENCE_NODE
Only the EntityReference node itself is adopted, the descendants are discarded, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
NOTATION_NODE
Notation nodes cannot be adopted.
PROCESSING_INSTRUCTION_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
These nodes can all be adopted. No specifics.
Should this method simply return null when it fails? How "exceptional" is failure for this method?Stick with raising exceptions only in exceptional circumstances, return null on failure (F2F 19 Jun 2000).Can an entity node really be adopted?No, neither can Notation nodes (Telcon 13 Dec 2000).Does this affect keys and hashCode's of the adopted subtree nodes?If so, what about readonly-ness of key and hashCode?if not, would appendChild affect keys/hashCodes or would it generate exceptions if key's are duplicate? Both keys and hashcodes have been dropped.
Specified by:
adoptNode in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
source - The node to move into this document.
Returns:
The adopted node, or null if this operation fails, such as when the source node comes from a different implementation.
Throws:
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the source node is of type DOCUMENT, DOCUMENT_TYPE.
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.

getActualEncoding

public java.lang.String getActualEncoding()
Description copied from interface: org.w3c.dom.Document
An attribute specifying the actual encoding of this document. This is null otherwise.
This attribute represents the property [character encoding scheme] defined in .
Specified by:
getActualEncoding in interface org.w3c.dom.Document

setActualEncoding

public void setActualEncoding(java.lang.String actualEncoding)
Description copied from interface: org.w3c.dom.Document
An attribute specifying the actual encoding of this document. This is null otherwise.
This attribute represents the property [character encoding scheme] defined in .
Specified by:
setActualEncoding in interface org.w3c.dom.Document

getEncoding

public java.lang.String getEncoding()
Description copied from interface: org.w3c.dom.Document
An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified.
Specified by:
getEncoding in interface org.w3c.dom.Document

setEncoding

public void setEncoding(java.lang.String encoding)
Description copied from interface: org.w3c.dom.Document
An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified.
Specified by:
setEncoding in interface org.w3c.dom.Document

getVersion

public java.lang.String getVersion()
Description copied from interface: org.w3c.dom.Document
An attribute specifying, as part of the XML declaration, the version number of this document. This is null when unspecified.
This attribute represents the property [version] defined in .
Specified by:
getVersion in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Throws:
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by this Document.

setVersion

public void setVersion(java.lang.String version)
Description copied from interface: org.w3c.dom.Document
An attribute specifying, as part of the XML declaration, the version number of this document. This is null when unspecified.
This attribute represents the property [version] defined in .
Specified by:
setVersion in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Throws:
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by this Document.

getStandalone

public boolean getStandalone()
Description copied from interface: org.w3c.dom.Document
An attribute specifying, as part of the XML declaration, whether this document is standalone.
This attribute represents the property [standalone] defined in .
Specified by:
getStandalone in interface org.w3c.dom.Document

setStandalone

public void setStandalone(boolean standalone)
Description copied from interface: org.w3c.dom.Document
An attribute specifying, as part of the XML declaration, whether this document is standalone.
This attribute represents the property [standalone] defined in .
Specified by:
setStandalone in interface org.w3c.dom.Document

getStrictErrorChecking

public boolean getStrictErrorChecking()
Description copied from interface: org.w3c.dom.Document
An attribute specifying whether errors checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException. In case of error, the behavior is undefined. This attribute is true by defaults.
Specified by:
getStrictErrorChecking in interface org.w3c.dom.Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)
Description copied from interface: org.w3c.dom.Document
An attribute specifying whether errors checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException. In case of error, the behavior is undefined. This attribute is true by defaults.
Specified by:
setStrictErrorChecking in interface org.w3c.dom.Document

getErrorHandler

public org.w3c.dom.DOMErrorHandler getErrorHandler()
Description copied from interface: org.w3c.dom.Document
This attribute allows applications to specify a DOMErrorHandler to be called in the event that an error is encountered while performing an operation on a document. Note that not all methods use this mechanism, see the description of each method for details.
Specified by:
getErrorHandler in interface org.w3c.dom.Document

setErrorHandler

public void setErrorHandler(org.w3c.dom.DOMErrorHandler errorHandler)
Description copied from interface: org.w3c.dom.Document
This attribute allows applications to specify a DOMErrorHandler to be called in the event that an error is encountered while performing an operation on a document. Note that not all methods use this mechanism, see the description of each method for details.
Specified by:
setErrorHandler in interface org.w3c.dom.Document

getDocumentURI

public java.lang.String getDocumentURI()
Description copied from interface: org.w3c.dom.Document
The location of the document or null if undefined.
Beware that when the Document supports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.
Specified by:
getDocumentURI in interface org.w3c.dom.Document

setDocumentURI

public void setDocumentURI(java.lang.String documentURI)
Description copied from interface: org.w3c.dom.Document
The location of the document or null if undefined.
Beware that when the Document supports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.
Specified by:
setDocumentURI in interface org.w3c.dom.Document

normalizeDocument

public void normalizeDocument()
Description copied from interface: org.w3c.dom.Document
This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. The actual result depends on the features being set and governing what operations actually take place. See setNormalizeFeature for details.
Noticeably this method normalizes Text nodes, makes the document "namespace wellformed", according to the algorithm described below in pseudo code, by adding missing namespace declaration attributes and adding or changing namespace prefixes, updates the replacement tree of EntityReference nodes, normalizes attribute values, etc.
See for details on how namespace declaration attributes and prefixes are normalized.Any other name? Joe proposes normalizeNamespaces.normalizeDocument. (F2F 26 Sep 2001)How specific should this be? Should we not even specify that this should be done by walking down the tree?Very. See above.What does this do on attribute nodes?Doesn't do anything (F2F 1 Aug 2000).How does it work with entity reference subtree which may be broken?This doesn't affect entity references which are not visited in this operation (F2F 1 Aug 2000).Should this really be on Node?Yes, but this only works on Document, Element, and DocumentFragment. On other types it is a no-op. (F2F 1 Aug 2000).No. Now that it does much more than simply fixing namespaces it only makes sense on Document (F2F 26 Sep 2001). What happens with read-only nodes?What/how errors should be reported? Are there any?Through the error reporter.Should this be optional?No. What happens with regard to mutation events?
Specified by:
normalizeDocument in interface org.w3c.dom.Document

canSetNormalizationFeature

public boolean canSetNormalizationFeature(java.lang.String name,
                                          boolean state)
Description copied from interface: org.w3c.dom.Document
Query whether setting a feature to a specific value is supported.
The feature name has the same form as a DOM hasFeature string.
Specified by:
canSetNormalizationFeature in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
name - The name of the feature to check.
state - The requested state of the feature (true or false).
Returns:
true if the feature could be successfully set to the specified value, or false if the feature is not recognized or the requested value is not supported. This does not change the current value of the feature itself.

setNormalizationFeature

public void setNormalizationFeature(java.lang.String name,
                                    boolean state)
                             throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Set the state of a feature.Need to specify the list of features.
Feature names are valid XML names. Implementation specific features (extensions) should choose an implementation specific prefix to avoid name collisions. The following lists feature names that are recognized by all implementations. However, it is sometimes possible for a Document to recognize a feature but not to support setting its value. The following list of recognized features indicates the definitions of each feature state, if setting the state to true or false must be supported or is optional and, which state is the default one:
"normalize-characters"
true
[optional]Perform the W3C Text Normalization of the characters in the document.
false
[required] (default)Do not perform character normalization.
"split-cdata-sections"
true
[ required] (default)Split CDATA sections containing the CDATA section termination marker ']]>'. When a CDATA section is split a warning is issued.
false
[required]Signal an error if a CDATASection contains an unrepresentable character.
"expand-entity-references"
true
[optional] Expand EntityReference nodes when normalizing.
false
[required] (default)Keep all EntityReference nodes in document.
"whitespace-in-element-content"
true
[required ] (default)Keep all white spaces in the document.
false
[ optional]Discard white space in element content while normalizing. The implementation is expected to use the isWhitespaceInElementContent flag on Text nodes to determine if a text node should be written out or not.
"discard-default-content"
true
[required] ( default)Use whatever information available to the implementation (i.e. XML schema, DTD, the specified flag on Attr nodes, and so on) to decide what attributes and content should be discarded or not. Note that the specified flag on Attr nodes in itself is not always reliable, it is only reliable when it is set to false since the only case where it can be set to false is if the attribute was created by a Level 1 implementation.How does exactly work? What's the comment about level 1 implementations?
false
[required]Keep all attributes and all content.
"format-canonical"
true
[optional] Canonicalize the document according to the rules specified in . Setting this feature to true sets the feature "format-pretty-print" to false.
false
[required] (default)Do not canonicalize the document.
"format-pretty-print"
true
[ optional]Format the document by adding whitespace to produce a pretty-printed, indented, human-readable form. The exact form of the transformations is not specified by this specification. Setting this feature to true sets the feature "format-canonical" to false.
false
[required] (default)Do not pretty-print the document.
"namespace-declarations"
true
[ required] (default)Include namespace declaration attributes, specified or defaulted from the schema or the DTD, in the document. See also the section Declaring Namespaces in .
false
[ optional]Discard all namespace declaration attributes. The Namespace prefixes are retained even if this feature is set to false.
"validation"
true
[optional ]Use the abstract schema to validate the document as it is being normalized. If validation errors are found the error handler is notified. Setting it to true also forces the external-general-entities and external-parameter-entities features to be true.) Also note that the validate-if-schema feature alters the validation behavior when this feature is set to true.
false
[required] (default)Do not report validation errors.
"external-parameter-entities"
true
[required]Load external parameter entities.Doesn't really apply, does it? What does including them mean? Also, false can't be the default and be optional at the same time.
false
[optional] (default)Do not load external parameter entities.
"external-general-entities"
true
[ required] (default)Include all external general (text) entities. Doesn't really apply, does it? What does including them mean?
false
[optional]Do not include external general entities.
"external-dtd-subset"
true
[required] (default )Load the external DTD subset and also all external parameter entities.Doesn't really apply, does it? What does loading mean here?
false
[optional]Do not load the external DTD subset nor external parameter entities.
"validate-if-schema"
true
[optional]When both this feature and validation are true, enable validation only if the document being processed has a schema (i.e. XML schema, DTD, any other type of schema, note that this is unrelated to the abstract schema specification). Documents without schemas are normalized without validation.How does that interact with the notion of active AS?
false
[required] (default)The validation feature alone controls whether the document is checked for validity. Documents without a schemas are not valid.
"validate-against-dtd"
true
[optional]Prefer validation against the DTD over any other schema used with the document.How does that interact with the notion of active AS?
false
[required] (default)Let the implementation decide what to validate against if multiple types of schemas are in use.
"datatype-normalization"
true
[required]Let the (non-DTD) validation process do its datatype normalization that is defined in the used schema language.We should define "datatype normalization".
false
[ required] (default)Disable datatype normalization. The XML 1.0 attribute value normalization always occurs though.
"create-entity-ref-nodes"
true
[required] ( default)Create EntityReference nodes in the document. It will also set create-entity-nodes to be true .How does that interact with expand-entity-references? ALH suggests consolidating the two to a single feature called "entity-references" that is used both for load and save.
false
[optional]Omit all EntityReference nodes from the document, putting the entity expansions directly in their place. Text nodes are into "normal" form. EntityReference nodes to non-defined entities are still created in the document.
"create-entity-nodes"
true
[required] (default )Create Entity nodes in the document.How does that interact with expand-entity-references? ALH suggests renaming this one "entity-nodes", or simply "entities" for consistency.
false
[optional]Omit all entity nodes from the document. It also sets create-entity-ref-nodes to false.
"create-cdata-nodes"
true
[ required] (default)Keep CDATASection nodes the document. Name does not work really well in this case. ALH suggests renaming this to "cdata-sections". It works for both load and save.
false
[optional]Transform CDATASection nodes in the document into Text nodes. The new Text node is then combined with any adjacent Text node.
"comments"
true
[ required] (default)Keep Comment nodes in the document.
false
[required]Discard Comment nodes in the Document.
"load-as-infoset"
true
[optional] Only keep in the document the information defined in the XML Information Set .This forces the following features to false: namespace-declarations, validate-if-schema, create-entity-ref-nodes , create-entity-nodes, create-cdata-nodes. This forces the following features to true: datatype-normalization, whitespace-in-element-content, comments. Other features are not changed unless explicity specified in the description of the features. Note that querying this feature with getFeature returns true only if the individual features specified above are appropriately set.Name doesn't work well here. ALH suggests renaming this to limit-to-infoset or match-infoset, something like that.
false
Setting load-as-infoset to false has no effect.Shouldn't we change this to setting the relevant options back to their default value?
Specified by:
setNormalizationFeature in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
name - The name of the feature to set.
state - The requested state of the feature (true or false).
Throws:
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised when the feature name is recognized but the requested value cannot be set.
NOT_FOUND_ERR: Raised when the feature name is not recognized.

getNormalizationFeature

public boolean getNormalizationFeature(java.lang.String name)
                                throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Look up the value of a feature.
The feature name has the same form as a DOM hasFeature string. The recognized features are the same as the ones defined for setNormalizationFeature.
Specified by:
getNormalizationFeature in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
name - The name of the feature to look up.
Returns:
The current state of the feature (true or false).
Throws:
org.w3c.dom.DOMException - NOT_FOUND_ERR: Raised when the feature name is not recognized.

renameNode

public org.w3c.dom.Node renameNode(org.w3c.dom.Node n,
                                   java.lang.String namespaceURI,
                                   java.lang.String name)
                            throws org.w3c.dom.DOMException
Description copied from interface: org.w3c.dom.Document
Rename an existing node. When possible this simply changes the name of the given node, otherwise this creates a new node with the specified name and replaces the existing node with the new node as described below. This only applies to nodes of type ELEMENT_NODE and ATTRIBUTE_NODE.
When a new node is created, the following operations are performed: the new node is created, any registered event listener is registered on the new node, any user data attached to the old node is removed from that node, the old node is removed from its parent if it has one, the children are moved to the new node, if the renamed node is an Element its attributes are moved to the new node, the new node is inserted at the position the old node used to have in its parent's child nodes list if it has one, the user data that was attached to the old node is attach to the new node, the user data event NODE_RENAMED is fired.
When the node being renamed is an Attr that is attached to an Element, the node is first removed from the Element attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.
In addition, when the implementation supports the feature "MutationEvents", each mutation operation involved in this method fires the appropriate event, and in the end the event ElementNameChanged or AttributeNameChanged is fired.Should this throw a HIERARCHY_REQUEST_ERR?
Specified by:
renameNode in interface org.w3c.dom.Document
Following copied from interface: org.w3c.dom.Document
Parameters:
n - The node to rename.
namespaceURI - The new namespaceURI.
name - The new qualified name.
Returns:
The renamed node. This is either the specified node or the new node that was created to replace the specified node.
Throws:
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised when the type of the specified node is neither ELEMENT_NODE nor ATTRIBUTE_NODE.

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

wrapper

public static DocumentImpl wrapper(Document spartan)