Xerces-C++  3.1.3
List of all members
DOMDocument Class Referenceabstract

The DOMDocument interface represents the entire XML document. More...

Inheritance diagram for DOMDocument:
DOMDocumentRange DOMXPathEvaluator DOMDocumentTraversal DOMNode

Public Member Functions

Destructor
virtual ~DOMDocument ()
 Destructor. More...
 
Functions introduced in DOM Level 1
virtual DOMElementcreateElement (const XMLCh *tagName)=0
 Creates an element of the type specified. More...
 
virtual DOMDocumentFragmentcreateDocumentFragment ()=0
 Creates an empty DOMDocumentFragment object. More...
 
virtual DOMTextcreateTextNode (const XMLCh *data)=0
 Creates a DOMText node given the specified string. More...
 
virtual DOMCommentcreateComment (const XMLCh *data)=0
 Creates a DOMComment node given the specified string. More...
 
virtual DOMCDATASectioncreateCDATASection (const XMLCh *data)=0
 Creates a DOMCDATASection node whose value is the specified string. More...
 
virtual DOMProcessingInstructioncreateProcessingInstruction (const XMLCh *target, const XMLCh *data)=0
 Creates a DOMProcessingInstruction node given the specified name and data strings. More...
 
virtual DOMAttrcreateAttribute (const XMLCh *name)=0
 Creates an DOMAttr of the given name. More...
 
virtual DOMEntityReferencecreateEntityReference (const XMLCh *name)=0
 Creates an DOMEntityReference object. More...
 
virtual DOMDocumentTypegetDoctype () const =0
 The Document Type Declaration (see DOMDocumentType) associated with this document. More...
 
virtual DOMImplementationgetImplementation () const =0
 The DOMImplementation object that handles this document. More...
 
virtual DOMElementgetDocumentElement () const =0
 This is a convenience attribute that allows direct access to the child node that is the root element of the document. More...
 
virtual DOMNodeListgetElementsByTagName (const XMLCh *tagname) const =0
 Returns a DOMNodeList of all the DOMElement(s) with a given tag name in the order in which they are encountered in a preorder traversal of the DOMDocument tree. More...
 
Functions introduced in DOM Level 2.
virtual DOMNodeimportNode (const DOMNode *importedNode, bool deep)=0
 Imports a node from another document to this document. More...
 
virtual DOMElementcreateElementNS (const XMLCh *namespaceURI, const XMLCh *qualifiedName)=0
 Creates an element of the given qualified name and namespace URI. More...
 
virtual DOMAttrcreateAttributeNS (const XMLCh *namespaceURI, const XMLCh *qualifiedName)=0
 Creates an attribute of the given qualified name and namespace URI. More...
 
virtual DOMNodeListgetElementsByTagNameNS (const XMLCh *namespaceURI, const XMLCh *localName) const =0
 Returns a DOMNodeList of all the DOMElement(s) with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the DOMDocument tree. More...
 
virtual DOMElementgetElementById (const XMLCh *elementId) const =0
 Returns the DOMElement whose ID is given by elementId. More...
 
Functions introduced in DOM Level 3.
virtual const XMLChgetInputEncoding () const =0
 An attribute specifying the encoding used for this document at the time of the parsing. More...
 
virtual const XMLChgetXmlEncoding () const =0
 An attribute specifying, as part of the XML declaration, the encoding of this document. More...
 
virtual bool getXmlStandalone () const =0
 An attribute specifying, as part of the XML declaration, whether this document is standalone. More...
 
virtual void setXmlStandalone (bool standalone)=0
 An attribute specifying, as part of the XML declaration, whether this document is standalone. More...
 
virtual const XMLChgetXmlVersion () const =0
 An attribute specifying, as part of the XML declaration, the version number of this document. More...
 
virtual void setXmlVersion (const XMLCh *version)=0
 An attribute specifying, as part of the XML declaration, the version number of this document. More...
 
virtual const XMLChgetDocumentURI () const =0
 The location of the document or null if undefined. More...
 
virtual void setDocumentURI (const XMLCh *documentURI)=0
 The location of the document or null if undefined. More...
 
virtual bool getStrictErrorChecking () const =0
 An attribute specifying whether errors checking is enforced or not. More...
 
virtual void setStrictErrorChecking (bool strictErrorChecking)=0
 An attribute specifying whether errors checking is enforced or not. More...
 
virtual DOMNoderenameNode (DOMNode *n, const XMLCh *namespaceURI, const XMLCh *qualifiedName)=0
 Rename an existing node. More...
 
virtual DOMNodeadoptNode (DOMNode *source)=0
 Changes the ownerDocument of a node, its children, as well as the attached attribute nodes if there are any. More...
 
virtual void normalizeDocument ()=0
 This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. More...
 
virtual DOMConfigurationgetDOMConfig () const =0
 The configuration used when DOMDocument::normalizeDocument is invoked. More...
 
Non-standard extension
virtual DOMEntitycreateEntity (const XMLCh *name)=0
 Non-standard extension. More...
 
virtual DOMDocumentTypecreateDocumentType (const XMLCh *name)=0
 Non-standard extension. More...
 
virtual DOMDocumentTypecreateDocumentType (const XMLCh *qName, const XMLCh *, const XMLCh *)
 
virtual DOMNotationcreateNotation (const XMLCh *name)=0
 Non-standard extension. More...
 
virtual DOMElementcreateElementNS (const XMLCh *namespaceURI, const XMLCh *qualifiedName, const XMLFileLoc lineNum, const XMLFileLoc columnNum)=0
 Non-standard extension. More...
 
- Public Member Functions inherited from DOMDocumentRange
virtual ~DOMDocumentRange ()
 Destructor. More...
 
virtual DOMRangecreateRange ()=0
 To create the range consisting of boundary-points and offset of the selected contents. More...
 
- Public Member Functions inherited from DOMXPathEvaluator
virtual ~DOMXPathEvaluator ()
 Destructor. More...
 
virtual DOMXPathExpressioncreateExpression (const XMLCh *expression, const DOMXPathNSResolver *resolver)=0
 Creates a parsed XPath expression with resolved namespaces. More...
 
virtual DOMXPathNSResolvercreateNSResolver (const DOMNode *nodeResolver)=0
 Adapts any DOM node to resolve namespaces so that an XPath expression can be easily evaluated relative to the context of the node where it appeared within the document. More...
 
virtual DOMXPathResultevaluate (const XMLCh *expression, const DOMNode *contextNode, const DOMXPathNSResolver *resolver, DOMXPathResult::ResultType type, DOMXPathResult *result)=0
 Evaluates an XPath expression string and returns a result of the specified type if possible. More...
 
- Public Member Functions inherited from DOMDocumentTraversal
virtual ~DOMDocumentTraversal ()
 Destructor. More...
 
virtual DOMNodeIteratorcreateNodeIterator (DOMNode *root, DOMNodeFilter::ShowType whatToShow, DOMNodeFilter *filter, bool entityReferenceExpansion)=0
 Creates a NodeIterator object. More...
 
virtual DOMTreeWalkercreateTreeWalker (DOMNode *root, DOMNodeFilter::ShowType whatToShow, DOMNodeFilter *filter, bool entityReferenceExpansion)=0
 Creates a TreeWalker object. More...
 
- Public Member Functions inherited from DOMNode
virtual ~DOMNode ()
 Destructor. More...
 
virtual const XMLChgetNodeName () const =0
 The name of this node, depending on its type; see the table above. More...
 
virtual const XMLChgetNodeValue () const =0
 Gets the value of this node, depending on its type. More...
 
virtual NodeType getNodeType () const =0
 An enum value representing the type of the underlying object. More...
 
virtual DOMNodegetParentNode () const =0
 Gets the parent of this node. More...
 
virtual DOMNodeListgetChildNodes () const =0
 Gets a DOMNodeList that contains all children of this node. More...
 
virtual DOMNodegetFirstChild () const =0
 Gets the first child of this node. More...
 
virtual DOMNodegetLastChild () const =0
 Gets the last child of this node. More...
 
virtual DOMNodegetPreviousSibling () const =0
 Gets the node immediately preceding this node. More...
 
virtual DOMNodegetNextSibling () const =0
 Gets the node immediately following this node. More...
 
virtual DOMNamedNodeMapgetAttributes () const =0
 Gets a DOMNamedNodeMap containing the attributes of this node (if it is an DOMElement) or null otherwise. More...
 
virtual DOMDocumentgetOwnerDocument () const =0
 Gets the DOMDocument object associated with this node. More...
 
virtual DOMNodecloneNode (bool deep) const =0
 Returns a duplicate of this node. More...
 
virtual DOMNodeinsertBefore (DOMNode *newChild, DOMNode *refChild)=0
 Inserts the node newChild before the existing child node refChild. More...
 
virtual DOMNodereplaceChild (DOMNode *newChild, DOMNode *oldChild)=0
 Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. More...
 
virtual DOMNoderemoveChild (DOMNode *oldChild)=0
 Removes the child node indicated by oldChild from the list of children, and returns it. More...
 
virtual DOMNodeappendChild (DOMNode *newChild)=0
 Adds the node newChild to the end of the list of children of this node. More...
 
virtual bool hasChildNodes () const =0
 This is a convenience method to allow easy determination of whether a node has any children. More...
 
virtual void setNodeValue (const XMLCh *nodeValue)=0
 Sets the value of the node. More...
 
virtual void normalize ()=0
 Puts all DOMText nodes in the full depth of the sub-tree underneath this DOMNode, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates DOMText nodes, i.e., there are neither adjacent DOMText nodes nor empty DOMText nodes. More...
 
virtual bool isSupported (const XMLCh *feature, const XMLCh *version) const =0
 Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. More...
 
virtual const XMLChgetNamespaceURI () const =0
 Get the namespace URI of this node, or null if it is unspecified. More...
 
virtual const XMLChgetPrefix () const =0
 Get the namespace prefix of this node, or null if it is unspecified. More...
 
virtual const XMLChgetLocalName () const =0
 Returns the local part of the qualified name of this node. More...
 
virtual void setPrefix (const XMLCh *prefix)=0
 Set the namespace prefix of this node. More...
 
virtual bool hasAttributes () const =0
 Returns whether this node (if it is an element) has any attributes. More...
 
virtual bool isSameNode (const DOMNode *other) const =0
 Returns whether this node is the same node as the given one. More...
 
virtual bool isEqualNode (const DOMNode *arg) const =0
 Tests whether two nodes are equal. More...
 
virtual void * setUserData (const XMLCh *key, void *data, DOMUserDataHandler *handler)=0
 Associate an object to a key on this node. More...
 
virtual void * getUserData (const XMLCh *key) const =0
 Retrieves the object associated to a key on a this node. More...
 
virtual const XMLChgetBaseURI () const =0
 The absolute base URI of this node or null if undefined. More...
 
virtual short compareDocumentPosition (const DOMNode *other) const =0
 Compares the reference node, i.e. More...
 
virtual const XMLChgetTextContent () const =0
 This attribute returns the text content of this node and its descendants. More...
 
virtual void setTextContent (const XMLCh *textContent)=0
 This attribute removes any possible children this node may have and, if the new string is not empty or null, replaced by a single DOMText node containing the string this attribute is set to. More...
 
virtual const XMLChlookupPrefix (const XMLCh *namespaceURI) const =0
 Look up the prefix associated to the given namespace URI, starting from this node. More...
 
virtual bool isDefaultNamespace (const XMLCh *namespaceURI) const =0
 This method checks if the specified namespaceURI is the default namespace or not. More...
 
virtual const XMLChlookupNamespaceURI (const XMLCh *prefix) const =0
 Look up the namespace URI associated to the given prefix, starting from this node. More...
 
virtual void * getFeature (const XMLCh *feature, const XMLCh *version) const =0
 This method makes available a DOMNode's specialized interface. More...
 
virtual void release ()=0
 Called to indicate that this Node (and its associated children) is no longer in use and that the implementation may relinquish any resources associated with it and its associated children. More...
 

Protected Member Functions

Hidden constructors
 DOMDocument ()
 
- Protected Member Functions inherited from DOMDocumentRange
 DOMDocumentRange ()
 
- Protected Member Functions inherited from DOMXPathEvaluator
 DOMXPathEvaluator ()
 
- Protected Member Functions inherited from DOMDocumentTraversal
 DOMDocumentTraversal ()
 
- Protected Member Functions inherited from DOMNode
 DOMNode ()
 
 DOMNode (const DOMNode &)
 

Additional Inherited Members

- Public Types inherited from DOMNode
enum  NodeType {
  ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4,
  ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8,
  DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12
}
 NodeType. More...
 
enum  DocumentPosition {
  DOCUMENT_POSITION_DISCONNECTED = 0x01, DOCUMENT_POSITION_PRECEDING = 0x02, DOCUMENT_POSITION_FOLLOWING = 0x04, DOCUMENT_POSITION_CONTAINS = 0x08,
  DOCUMENT_POSITION_CONTAINED_BY = 0x10, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20
}
 DocumentPosition: More...
 

Detailed Description

The DOMDocument interface represents the entire XML document.

Conceptually, it is the root of the document tree, and provides the primary access to the document's data.

Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a DOMDocument, the DOMDocument interface also contains the factory methods needed to create these objects. The DOMNode objects created have a ownerDocument attribute which associates them with the DOMDocument within whose context they were created.

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

Constructor & Destructor Documentation

DOMDocument::DOMDocument ( )
protected
virtual DOMDocument::~DOMDocument ( )
virtual

Destructor.

Member Function Documentation

virtual DOMNode* DOMDocument::adoptNode ( DOMNode source)
pure virtual

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 DOMAttr. The descendants of the source DOMAttr are recursively adopted.
DOCUMENT_FRAGMENT_NODE
The descendants of the source node are recursively adopted.
DOCUMENT_NODE
DOMDocument nodes cannot be adopted.
DOCUMENT_TYPE_NODE
DOMDocumentType nodes cannot be adopted.
ELEMENT_NODE
Specified attribute nodes of the source element are adopted, and the generated DOMAttr 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
DOMEntity nodes cannot be adopted.
ENTITY_REFERENCE_NODE
Only the DOMEntityReference 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
DOMNotation nodes cannot be adopted.
PROCESSING_INSTRUCTION_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
These nodes can all be adopted. No specifics.
Parameters
sourceThe 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.
Exceptions
DOMExceptionNOT_SUPPORTED_ERR: Raised if the source node is of type DOCUMENT, DOCUMENT_TYPE.
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.
Since
DOM Level 3
virtual DOMAttr* DOMDocument::createAttribute ( const XMLCh name)
pure virtual

Creates an DOMAttr of the given name.

Note that the DOMAttr instance can then be set on an DOMElement using the setAttributeNode method.
To create an attribute with a qualified name and namespace URI, use the createAttributeNS method.

Parameters
nameThe name of the attribute.
Returns
A new DOMAttr 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.
Exceptions
DOMExceptionINVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
Since
DOM Level 1
virtual DOMAttr* DOMDocument::createAttributeNS ( const XMLCh namespaceURI,
const XMLCh qualifiedName 
)
pure virtual

Creates an attribute of the given qualified name and namespace URI.

Parameters
namespaceURIThe namespace URI of the attribute to create.
qualifiedNameThe qualified name of the attribute to instantiate.
Returns
A new DOMAttr object with the following attributes:
Attribute Value
DOMNode.nodeName qualifiedName
DOMNode.namespaceURI namespaceURI
DOMNode.prefix prefix, extracted from qualifiedName, or null if there is no prefix
DOMNode.localName local name, extracted from qualifiedName
DOMAttr.name qualifiedName
DOMNode.nodeValue the empty string
Exceptions
DOMExceptionINVALID_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.
Since
DOM Level 2
virtual DOMCDATASection* DOMDocument::createCDATASection ( const XMLCh data)
pure virtual

Creates a DOMCDATASection node whose value is the specified string.

Parameters
dataThe data for the DOMCDATASection contents.
Returns
The new DOMCDATASection object.
Since
DOM Level 1
virtual DOMComment* DOMDocument::createComment ( const XMLCh data)
pure virtual

Creates a DOMComment node given the specified string.

Parameters
dataThe data for the node.
Returns
The new DOMComment object.
Since
DOM Level 1
virtual DOMDocumentFragment* DOMDocument::createDocumentFragment ( )
pure virtual

Creates an empty DOMDocumentFragment object.

Returns
A new DOMDocumentFragment.
Since
DOM Level 1
virtual DOMDocumentType* DOMDocument::createDocumentType ( const XMLCh name)
pure virtual

Non-standard extension.

Create a DOMDocumentType node.

Returns
A DOMDocumentType that references the newly created DOMDocumentType node.
virtual DOMDocumentType* DOMDocument::createDocumentType ( const XMLCh qName,
const XMLCh ,
const XMLCh  
)
virtual
virtual DOMElement* DOMDocument::createElement ( const XMLCh tagName)
pure virtual

Creates an element of the type specified.

Note that the instance returned implements the DOMElement interface, so attributes can be specified directly on the returned object.
In addition, if there are known attributes with default values, DOMAttr 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.

Parameters
tagNameThe name of the element type to instantiate. For XML, this is case-sensitive.
Returns
A new DOMElement object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.
Exceptions
DOMExceptionINVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
Since
DOM Level 1
virtual DOMElement* DOMDocument::createElementNS ( const XMLCh namespaceURI,
const XMLCh qualifiedName 
)
pure virtual

Creates an element of the given qualified name and namespace URI.

Parameters
namespaceURIThe namespace URI of the element to create.
qualifiedNameThe qualified name of the element type to instantiate.
Returns
A new DOMElement object with the following attributes:
Attribute Value
DOMNode.nodeName qualifiedName
DOMNode.namespaceURI namespaceURI
DOMNode.prefix prefix, extracted from qualifiedName, or null if there is no prefix
DOMNode.localName local name, extracted from qualifiedName
DOMElement.tagName qualifiedName
Exceptions
DOMExceptionINVALID_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.
Since
DOM Level 2
virtual DOMElement* DOMDocument::createElementNS ( const XMLCh namespaceURI,
const XMLCh qualifiedName,
const XMLFileLoc  lineNum,
const XMLFileLoc  columnNum 
)
pure virtual

Non-standard extension.

Creates an element of the given qualified name and namespace URI, and also stores line/column number info. Used by internally XSDXercesDOMParser during schema traversal.

See also
createElementNS(const XMLCh *namespaceURI, const XMLCh *qualifiedName)
virtual DOMEntity* DOMDocument::createEntity ( const XMLCh name)
pure virtual

Non-standard extension.

Create a new entity.

Parameters
nameThe name of the entity to instantiate
virtual DOMEntityReference* DOMDocument::createEntityReference ( const XMLCh name)
pure virtual

Creates an DOMEntityReference object.

In addition, if the referenced entity is known, the child list of the DOMEntityReference node is made the same as that of the corresponding DOMEntity node.If any descendant of the DOMEntity node has an unbound namespace prefix, the corresponding descendant of the created DOMEntityReference node is also unbound; (its namespaceURI is null). The DOM Level 2 does not support any mechanism to resolve namespace prefixes.

Parameters
nameThe name of the entity to reference.
Returns
The new DOMEntityReference object.
Exceptions
DOMExceptionINVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
Since
DOM Level 1
virtual DOMNotation* DOMDocument::createNotation ( const XMLCh name)
pure virtual

Non-standard extension.

Create a Notation.

Parameters
nameThe name of the notation to instantiate
Returns
A DOMNotation that references the newly created DOMNotation node.
virtual DOMProcessingInstruction* DOMDocument::createProcessingInstruction ( const XMLCh target,
const XMLCh data 
)
pure virtual

Creates a DOMProcessingInstruction node given the specified name and data strings.

Parameters
targetThe target part of the processing instruction.
dataThe data for the node.
Returns
The new DOMProcessingInstruction object.
Exceptions
DOMExceptionINVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
Since
DOM Level 1
virtual DOMText* DOMDocument::createTextNode ( const XMLCh data)
pure virtual

Creates a DOMText node given the specified string.

Parameters
dataThe data for the node.
Returns
The new DOMText object.
Since
DOM Level 1
virtual DOMDocumentType* DOMDocument::getDoctype ( ) const
pure virtual

The Document Type Declaration (see DOMDocumentType) associated with this document.

For XML documents without a document type declaration this returns null. The DOM Level 2 does not support editing the Document Type Declaration. docType cannot be altered in any way, including through the use of methods inherited from the DOMNode interface, such as insertNode or removeNode.

Since
DOM Level 1
virtual DOMElement* DOMDocument::getDocumentElement ( ) const
pure virtual

This is a convenience attribute that allows direct access to the child node that is the root element of the document.

Since
DOM Level 1
virtual const XMLCh* DOMDocument::getDocumentURI ( ) const
pure virtual

The location of the document or null if undefined.


Beware that when the DOMDocument supports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.

Since
DOM Level 3
virtual DOMConfiguration* DOMDocument::getDOMConfig ( ) const
pure virtual

The configuration used when DOMDocument::normalizeDocument is invoked.

Returns
The DOMConfiguration from this DOMDocument
Since
DOM Level 3
virtual DOMElement* DOMDocument::getElementById ( const XMLCh elementId) const
pure virtual

Returns the DOMElement 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.

Parameters
elementIdThe unique id value for an element.
Returns
The matching element.
Since
DOM Level 2
virtual DOMNodeList* DOMDocument::getElementsByTagName ( const XMLCh tagname) const
pure virtual

Returns a DOMNodeList of all the DOMElement(s) with a given tag name in the order in which they are encountered in a preorder traversal of the DOMDocument tree.

The returned node list is "live", in that changes to the document tree made after a nodelist was initially returned will be immediately reflected in the node list.

Parameters
tagnameThe name of the tag to match on. The special value "*" matches all tags.
Returns
A new DOMNodeList object containing all the matched DOMElement(s).
Since
DOM Level 1
virtual DOMNodeList* DOMDocument::getElementsByTagNameNS ( const XMLCh namespaceURI,
const XMLCh localName 
) const
pure virtual

Returns a DOMNodeList of all the DOMElement(s) with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the DOMDocument tree.

Parameters
namespaceURIThe namespace URI of the elements to match on. The special value "*" matches all namespaces.
localNameThe local name of the elements to match on. The special value "*" matches all local names.
Returns
A new DOMNodeList object containing all the matched DOMElement(s).
Since
DOM Level 2
virtual DOMImplementation* DOMDocument::getImplementation ( ) const
pure virtual

The DOMImplementation object that handles this document.

A DOM application may use objects from multiple implementations.

Since
DOM Level 1
virtual const XMLCh* DOMDocument::getInputEncoding ( ) const
pure virtual

An attribute specifying the encoding used for this document at the time of the parsing.

This is null when it is not known, such as when the DOMDocument was created in memory.

Since
DOM Level 3
virtual bool DOMDocument::getStrictErrorChecking ( ) const
pure virtual

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.

Since
DOM Level 3
virtual const XMLCh* DOMDocument::getXmlEncoding ( ) const
pure virtual

An attribute specifying, as part of the XML declaration, the encoding of this document.

This is null when unspecified or when it is not known, such as when the DOMDocument was created in memory.

Since
DOM Level 3
virtual bool DOMDocument::getXmlStandalone ( ) const
pure virtual

An attribute specifying, as part of the XML declaration, whether this document is standalone.

This is false when unspecified.

Since
DOM Level 3
virtual const XMLCh* DOMDocument::getXmlVersion ( ) const
pure virtual

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 .

Since
DOM Level 3
virtual DOMNode* DOMDocument::importNode ( const DOMNode importedNode,
bool  deep 
)
pure virtual

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 on a DOMNode, the source node is not altered.
Additional information is copied as appropriate to the nodeType, attempting to mirror the behavior expected if a fragment of XML 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 DOMAttr. The descendants of the source DOMAttr are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the deep parameter has no effect on DOMAttr 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 element are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Otherwise, this simply generates an empty DOMDocumentFragment.
DOCUMENT_NODE
DOMDocument nodes cannot be imported.
DOCUMENT_TYPE_NODE
DOMDocumentType nodes cannot be imported.
ELEMENT_NODE
Specified attribute nodes of the source element are imported, and the generated DOMAttr nodes are attached to the generated DOMElement. 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
DOMEntity nodes can be imported, however in the current release of the DOM the DOMDocumentType is readonly. Ability to add these imported nodes to a DOMDocumentType 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 DOMEntity are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
ENTITY_REFERENCE_NODE
Only the DOMEntityReference 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
DOMNotation nodes can be imported, however in the current release of the DOM the DOMDocumentType is readonly. Ability to add these imported nodes to a DOMDocumentType 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 DOMNotation nodes since they never have any children.
PROCESSING_INSTRUCTION_NODE
The imported node copies its target and data values from those of the source node.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
These three types of nodes inheriting from DOMCharacterData copy their data and length attributes from those of the source node.
Parameters
importedNodeThe node to import.
deepIf true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This has no effect on DOMAttr , DOMEntityReference, and DOMNotation nodes.
Returns
The imported node that belongs to this DOMDocument.
Exceptions
DOMExceptionNOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.
Since
DOM Level 2
virtual void DOMDocument::normalizeDocument ( )
pure virtual

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. See DOMConfiguration for details.


Noticeably this method normalizes DOMText 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 DOMEntityReference nodes, normalizes attribute values, etc.
Mutation events, when supported, are generated to reflect the changes occurring on the document. Note that this is a partial implementation. Not all the required features are implemented. Currently DOMAttr and DOMText nodes are normalized. Features to remove DOMComment and DOMCDATASection work.

Since
DOM Level 3
virtual DOMNode* DOMDocument::renameNode ( DOMNode n,
const XMLCh namespaceURI,
const XMLCh qualifiedName 
)
pure virtual

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 DOMElement 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 DOMAttr that is attached to an DOMElement, the node is first removed from the DOMElement attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.

Parameters
nThe node to rename.
namespaceURIThe new namespaceURI.
qualifiedNameThe 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.
Exceptions
DOMExceptionNOT_SUPPORTED_ERR: Raised when the type of the specified node is neither ELEMENT_NODE nor ATTRIBUTE_NODE.
WRONG_DOCUMENT_ERR: Raised when the specified node was created from a different document than this document.
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" . Also raised, when the node being renamed is an attribute, if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/".
Since
DOM Level 3
virtual void DOMDocument::setDocumentURI ( const XMLCh documentURI)
pure virtual

The location of the document or null if undefined.


Beware that when the DOMDocument supports the feature "HTML" , the href attribute of the HTML BASE element takes precedence over this attribute.

Since
DOM Level 3
virtual void DOMDocument::setStrictErrorChecking ( bool  strictErrorChecking)
pure virtual

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.

Since
DOM Level 3
virtual void DOMDocument::setXmlStandalone ( bool  standalone)
pure virtual

An attribute specifying, as part of the XML declaration, whether this document is standalone.


This attribute represents the property [standalone] defined in .

Since
DOM Level 3
virtual void DOMDocument::setXmlVersion ( const XMLCh version)
pure virtual

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 .

Since
DOM Level 3

The documentation for this class was generated from the following file: