113
DBMS_XMLDOM

The DBMS_XMLDOM package is used to access XMLType objects, and implements the Document Object Model (DOM), an application programming interface for HTML and XML documents.

This chapter contains the following topics:

• Using DBMS_XMLDOM
  • Overview
  • Constants
  • Types
  • Exceptions
• Subprogram Groups
• Summary of DBMS_XMLDOM Subprograms

---

Using DBMS_XMLDOM

• Overview
• Constants
• Types
• Exceptions
• Subprogram Groups

---

Overview

The Document Object Model (DOM) is an application programming interface (API) for HTML and XML documents. It defines the logical structure of documents, and the manner in which they are accessed and manipulated. In the DOM specification, the term "document" is used in the broad sense. XML is being increasingly used to represent many different kinds of information that may be stored in diverse systems. This information has been traditionally be seen as "data"; nevertheless, XML presents this data as documents, and the DBMS_XMLDOM package allows you access to both schema-based and non schema-based documents.

With DOM, anything found in an HTML or XML document can be accessed, changed, deleted, or added using the Document Object Model, with a few exceptions. In particular, the DOM interfaces for the XML internal and external subsets have not yet been specified.

One important objective of the W3C DOM specification is to provide a standard programming interface that can be used in a wide variety of environments, programming languages, and applications. Because the DOM standard is object-oriented while PL/SQL is essentially a procedural language, some changes had to be made:

• Various DOM interfaces such as Node, Element, and others have equivalent PL/SQL types DOMNode, DOMElement, respectively.
• Various DOMException codes such as WRONG_DOCUMENT_ERR, HIERARCHY_REQUEST_ERR, and others, have similarly named PL/SQL exceptions.
• Various DOM Node type codes such as ELEMENT_NODE, ATTRIBUTE_NODE, and others, have similarly named PL/SQL constants.
• Subprograms defined on a DOM type become functions or procedures that accept it as a parameter. For example, to perform APPENDCHILD Function on a DOMNode n, the APPENDCHILD Function PL/SQL function is provided.
• To perform setAttribute on a DOMElement elem, use SETATTRIBUTE Procedures PL/SQL procedure .

DOM defines an inheritance hierarchy. For example, Document, Element, and Attr are defined to be subtypes of Node (see Figure 113-1). Thus, a method defined in the Node interface should be available in these as well. Since such inheritance is not supported in PL/SQL, it is implemented through direct invocation of the MAKENODE function. Calling MAKENODE on various DOM types converts these types into a DOMNode. The appropriate functions or procedures that accept DOMNodes can then be called to operate on these types. If, subsequently, type specific functionality is desired, the DOMNode can be converted back into the original type by the makeXXX functions, where DOMXXX is the desired DOM type.

Figure 113-1 Inheritance Diagram for DOM Types

Text description of the illustration arpls010.gif

The implementation of this interface follows the REC-DOM-Level-1-19981001.

---

Constants

Defined constants of DBMS_XMLDOM are listed in Table 113-1.

Table 113-1  Defined Constants for DBMS_XMLDOM

Constant	Description
ATTRIBUTE_NODE	The Node is an Attribute.
CDATA_SECTION_NODE	The Node is a CDataSection.
COMMENT_NODE	The Node is a Comment.
DOCUMENT_FRAGMENT_NODE	The Node is a Document fragment.
DOCUMENT_NODE	The Node is a Document.
DOCUMENT_TYPE_NODE	The Node is a Document Type Definition.
ELEMENT_NODE	The Node is an Element.
ENTITY_NODE	The Node is an Entity.
ENTITY_REFERENCE_NODE	The Node is an Entity Reference.
NOTATION_NODE	The Node is a Notation.
PROCESSING_INSTRUCTION_NODE	The Node is a Processing Instruction.
TEXT_NODE	The Node is a Text node.

---

Types

The following types for DBMS_XMLDOM.DOMTYPE are defined in Table 113-2:

Table 113-2  XDB_XMLDOM Types

Type	Description
DOMATTR	Implements the DOM Attribute interface.
DOMCDATASECTION	Implements the DOM CDataSection interface.
DOMCHARACTERDATA	Implements the DOM Character Data interface.
DOMCOMMENT	Implements the DOM Comment interface.
DOMDOCUMENT	Implements the DOM Document interface.
DOMDOCUMENTFRAGMENT	Implements the DOM DocumentFragment interface.
DOMDOCUMENTTYPE	Implements the DOM Document Type interface.
DOMELEMENT	Implements the DOM Element interface.
DOMENTITY	Implements the DOM Entity interface.
DOMENTITYREFERENCE	Implements the DOM EntityReference interface.
DOMIMPLEMENTATION	Implements the DOM Implementation interface.
DOMNAMEDNODEMAP	Implements the DOM Named Node Map interface.
DOMNODE	Implements the DOM Node interface.
DOMNODELIST	Implements the DOM NodeList interface.
DOMNOTATION	Implements the DOM Notation interface.
DOMPROCESSINGINSTRUCTION	Implements the DOM Processing instruction interface.
DOMTEXT	Implements the DOM Text interface.

---

Exceptions

The exceptions listed in Table 113-3 are defined for DBMS_XMLDOM:

Table 113-3  Exceptions for DBMS_XMLDOM

Exception	Description
DOMSTRING_SIZE_ERR	If the specified range of text does not fit into a DOMString.
HIERARCHY_REQUEST_ERR	If any node is inserted somewhere it doesn't belong.
INDEX_SIZE_ERR	If index or size is negative, or greater than the allowed value.
INUSE_ATTRIBUTE_ERR	If an attempt is made to add an attribute that is already in use elsewhere.
INVALID_CHARACTER_ERR	If an invalid or illegal character is specified, such as in a name. See production 2 in the XML specification for the definition of a legal character, and production 5 for the definition of a legal name character.
NO_DATA_ALLOWED_ERROR	If data is specified for a node that does not support data.
NO_FOUND_ERR	If an attempt is made to reference a node in a context where it does not exist.
NO_MODIFICATION_ALLOWED_ERR	If an attempt is made to modify an object where modifications are not allowed.
NOT_SUPPORTED_ERR	If the implementation does not support the requested type of object or operation.
WRONG_DOCUMENT_ERR	If a node is used in a different document than the one that created it (that doesn't support it).

---

Subprogram Groups

DBMS_XMLDOM subprograms are divided into groups according to W3C Interfaces.

• DOMNode Subprograms
• DOMAttr Subprograms
• DOMCDataSection Subprograms
• DOMCharacterData Subprograms
• DOMComment Subprograms
• DOMDocument Subprograms
• DOMDocumentFragment Subprograms
• DOMDocumentType Subprograms
• DOMElement Subprograms
• DOMEntity Subprograms
• DOMEntityReference Subprograms
• DOMImplementation Subprograms
• DOMNamedNodeMap Subprograms
• DOMNodeList Subprograms
• DOMNotation Subprograms
• DOMProcessingInstruction Subprograms
• DOMText Subprograms

---

DOMNode Subprograms

Table 113-4  Summary of DOMNode Subprograms; DBMS_XMLDOM

Subprogram	Description
ADOPTNODE Procedure	Adopts a node from another document.
APPENDCHILD Function	Appends a new child to the node.
CLONENODE Function	Clones the node.
FREENODE Procedure	Frees all resources associated with the node.
GETATTRIBUTES Function	Retrieves the attributes of the node.
GETCHILDNODES Function	Retrieves the children of the node.
GETEXPANDEDNAME Procedure and Functions	Retrieves the expanded name of the node.
GETFIRSTCHILD Function	Retrieves the first child of the node.
GETLASTCHILD Function	Retrieves the last child of the node.
GETLOCALNAME Procedure and Functions	Retrieves the local part of the qualified name.
GETNAMESPACE Procedure and Functions	Retrieves the node's namespace URI.
GETNEXTSIBLING Function	Retrieves the next sibling of the node.
GETNODENAME Function	Retrieves the Name of the Node.
GETNODETYPE Function	Retrieves the Type of the node.
GETNODEVALUE Function	Retrieves the Value of the Node.
GETOWNERDOCUMENT Function	Retrieves the owner document of the node.
GETPARENTNODE Function	Retrieves the parent of this node.
GETPREFIX Function	Retrieves the namespace prefix.
GETPREVIOUSSIBLING Function	Retrieves the previous sibling of the node.
GETSCHEMANODE Function	Retrieves the associated schema URI.
HASATTRIBUTES Function	Tests if the node has attributes.
HASCHILDNODES Function	Tests if the node has child nodes.
IMPORTNODE Function	Imports a node from another document.
INSERTBEFORE Function	Inserts a child before the reference child.
ISNULL Functions	Tests if the node is NULL
MAKEATTR Function	Casts the node to an Attribute.
MAKECDATASECTION Function	Casts the node to a CData Section.
MAKECHARACTERDATA Function	Casts the node to Character Data.
MAKECOMMENT Function	Casts the node to a Comment.
MAKEDOCUMENT Function	Casts the node to a DOM Document.
MAKEDOCUMENTFRAGMENT Function	Casts the node to a DOM Document Fragment.
MAKEDOCUMENTTYPE Function	Casts the node to a DOM Document Type.
MAKEELEMENT Function	Casts the node to a DOM Element.
MAKEENTITY Function	Casts the node to a DOM Entity.
MAKEENTITYREFERENCE Function	Casts the node to a DOM Entity Reference.
MAKENOTATION Function	Casts the node to a DOM Notation.
MAKEPROCESSINGINSTRUCTION Function	Casts the node to a DOM Processing Instruction.
MAKETEXT Function	Casts the node to a DOM Text.
REMOVECHILD Function	Removes a specified child from a node.
REPLACECHILD Function	Replaces the old child with a new child.
SETNODEVALUE Procedure	Sets the Value of the node.
SETPREFIX Procedure	Sets the namespace prefix.
WRITETOBUFFER Procedures	Writes the contents of the node to a buffer.
WRITETOCLOB Procedures	Writes the contents of the node to a clob.
WRITETOFILE Procedures	Writes the contents of the node to a file.

---

DOMAttr Subprograms

Table 113-5  Summary of DOMAttr Subprograms; DBMS_XMLDOM

Method	Description
GETEXPANDEDNAME Procedure and Functions	Retrieves the expanded name of the attribute.
GETLOCALNAME Procedure and Functions	Retrieves the local name of the attribute.
GETNAME Functions	Retrieves the name of the attribute.
GETNAMESPACE Procedure and Functions	Retrieves the NS URI of the attribute.
GETOWNERELEMENT Function	Retrieves the Element node, parent of the attribute.
GETQUALIFIEDNAME Functions	Retrieves the Qualified Name of the attribute.
GETSPECIFIED Function	Tests if attribute was specified in the element.
GETVALUE Function	Retrieves the value of the attribute.
ISNULL Functions	Tests if the Attribute node is NULL.
MAKENODE Functions	Casts the Attribute to a node.
SETVALUE Procedure	Sets the value of the attribute.

---

DOMCDataSection Subprograms

Table 113-6  Summary of DOMCdata Subprograms; DBMS_XMLDOM

Method	Description
ISNULL Functions	Tests if the CDataSection is NULL.
MAKENODE Functions	Casts the CDatasection to a node.

---

DOMCharacterData Subprograms

Table 113-7  Summary of DOMCharacterData Subprograms; DBMS_XMLDOM

Method	Description
APPENDDATA Procedure	Appends the given data to the node data.
DELETEDATA Procedure	Deletes the data from the given offSets.
GETDATA Functions	Retrieves the data of the node.
GETLENGTH Functions	Retrieves the length of the data.
INSERTDATA Procedure	Inserts the data in the node at the given offSets.
ISNULL Functions	Tests if the CharacterData is NULL.
MAKENODE Functions	Casts the CharacterData to a node.
REPLACEDATA Procedure	Changes a range of characters in the node.
SETDATA Procedures	Sets the data to the node.
SUBSTRINGDATA Function	Retrieves the substring of the data.

---

DOMComment Subprograms

Table 113-8  Summary of DOMComment Subprograms; DBMS_XMLDOM

Method	Description
ISNULL Functions	Tests if the comment is NULL.
MAKENODE Functions	Casts the Comment to a node.

---

DOMDocument Subprograms

Table 113-9  Summary of DOMDocument Subprograms; DBMS_XMLDOM

Method	Description
CREATEATTRIBUTE Functions	Creates an Attribute.
CREATECDATASECTION Function	Creates a CDataSection node.
CREATECOMMENT Function	Creates a Comment node.
CREATEDOCUMENT Function	Creates a new Document.
CREATEDOCUMENTFRAGMENT Function	Creates a new Document Fragment.
CREATEELEMENT Functions	Creates a new Element.
CREATEENTITYREFERENCE Function	Creates an Entity reference.
CREATEPROCESSINGINSTRUCTION Function	Creates a Processing Instruction.
CREATETEXTNODE Function	Creates a Text node.
FREEDOCFRAG Procedure	Frees the document fragment.
FREEDOCUMENT Procedure	Frees the document.
GETDOCTYPE Function	Retrieves the DTD of the document.
GETDOCUMENTELEMENT Function	Retrieves the root element of the document.
GETELEMENTSBYTAGNAME Functions	Retrieves the elements in the by tag name.
GETIMPLEMENTATION Function	Retrieves the DOM implementation.
GETSTANDALONE Function	Retrieves the standalone property of the document.
GETVERSION Function	Retrieves the version of the document.
GETXMLTYPE Function	Retrieves the XMLType associated with the DOM Document.
ISNULL Functions	Tests if the document is NULL.
MAKENODE Functions	Casts the document to a node.
NEWDOMDOCUMENT Functions	Creates a new document.
SETSTANDALONE Procedure	Sets the characterset of the document.
SETSTANDALONE Procedure	Sets the standalone property of the document.
SETVERSION Procedure	Sets the version of the document.
WRITETOBUFFER Procedures	Writes the document to a buffer.
WRITETOCLOB Procedures	Writes the document to a CLOB.
WRITETOFILE Procedures	Writes the document to a file.

---

DOMDocumentFragment Subprograms

Table 113-10  Summary of DOMDocumentFragment Subprograms; DBMS_XMLDOM

Method	Description
FREEDOCFRAG Procedure	Frees the specified document fragment.
ISNULL Functions	Tests if the DocumentFragment is NULL.
MAKENODE Functions	Casts the Document Fragment to a node.
WRITETOBUFFER Procedures	Writes the contents of a document fragment into a buffer.

---

DOMDocumentType Subprograms

Table 113-11  Summary of DOMDocumentType Subprograms; DBMS_XMLDOM

Method	Description
FINDENTITY Function	Finds the specified entity in the document type.
FINDNOTATION Function	Finds the specified notation in the document type.
GETENTITIES Function	Retrieves the nodemap of entities in the Document type.
GETNAME Functions	Retrieves the name of the Document type.
GETNOTATIONS Function	Retrieves the nodemap of the notations in the Document type.
GETPUBLICID Functions	Retrieves the public ID of the document type.
GETSYSTEMID Functions	Retrieves the system ID of the document type.
ISNULL Functions	Tests if the Document Type is NULL.
MAKENODE Functions	Casts the document type to a node.

---

DOMElement Subprograms

Table 113-12  Summary of DOMElement Subprograms; DBMS_XMLDOM

Method	Description
GETATTRIBUTE Functions	Retrieves the attribute node by name.
GETATTRIBUTENODE Functions	Retrieves the attribute node by name.
GETCHILDRENBYTAGNAME Functions	Retrieves children of the element by tag name.
GETELEMENTSBYTAGNAME Functions	Retrieves elements in the subtree by tagname.
GETEXPANDEDNAME Procedure and Functions	Retrieves the expanded name of the element.
GETLOCALNAME Procedure and Functions	Retrieves the local name of the element.
GETNAMESPACE Procedure and Functions	Retrieves the NS URI of the element.
GETQUALIFIEDNAME Functions	Retrieves the qualified name of the element.
GETTAGNAME Function	Retrieves the Tag name of the element.
HASATTRIBUTE Functions	Tests if an attribute exists.
ISNULL Functions	Tests if the Element is NULL.
MAKENODE Functions	Casts the Element to a node.
NORMALIZE Procedure	Normalizes the text children of the element.
REMOVEATTRIBUTE Procedures	Removes the attribute specified by the name.
REMOVEATTRIBUTENODE Function	Removes the attribute node in the element.
RESOLVENAMESPACEPREFIX Function	Resolve the prefix to a namespace URI.
SETATTRIBUTE Procedures	Sets the attribute specified by the name.
SETATTRIBUTENODE Functions	Sets the attribute node in the element.

---

DOMEntity Subprograms

Table 113-13  Summary of DOMEntity Subprograms; DBMS_XMLDOM

Method	Description
GETNOTATIONNAME Function	Retrieves the notation name of the entity.
GETPUBLICID Functions	Retrieves the public Id of the entity.
GETSYSTEMID Functions	Retrieves the system Id of the entity.
ISNULL Functions	Tests if the Entity is NULL.
MAKENODE Functions	Casts the Entity to a node.

---

DOMEntityReference Subprograms

Table 113-14  Summary of DOMEntityReference Subprograms; DBMS_XMLDOM

Method	Description
ISNULL Functions	Tests if the DOMEntityReference is NULL.
MAKENODE Functions	Casts the DOMEntityReference to NULL.

---

DOMImplementation Subprograms

Table 113-15  Summary of DOMImplementation Subprograms; DBMS_XMLDOM

Method	Description
ISNULL Functions	Tests if the DOMImplementation node is NULL.
HASFEATURE Function	Tests if the DOMImplementation implements a feature.

---

DOMNamedNodeMap Subprograms

Table 113-16  Summary of DOMNamedNodeMap Subprograms; DBMS_XMLDOM

Method	Description
GETLENGTH Functions	Retrieves the number of items in the map.
GETNAMEDITEM Function	Retrieves the item specified by the name.
ISNULL Functions	Tests if the NamedNodeMap is NULL.
IITEM Functions	Retrieves the item given the index in the map.
REMOVENAMEDITEM Function	Removes the item specified by name.
SETNAMEDITEM Function	Sets the item in the map specified by the name.

---

DOMNodeList Subprograms

Table 113-17  Summary of DOMNodeList Subprograms; DBMS_XMLDOM

Method	Description
GETLENGTH Functions	Retrieves the number of items in the list.
ISNULL Functions	Tests if the NodeList is NULL.
IITEM Functions	Retrieves the item given the index in the NodeList.

---

DOMNotation Subprograms

Table 113-18  Summary of DOMNotation Subprograms; DBMS_XMLDOM

Method	Description
GETPUBLICID Functions	Retrieves the public Id of the notation.
GETSYSTEMID Functions	Retrieves the system Id of the notation.
ISNULL Functions	Tests if the Notation is NULL.
MAKENODE Functions	Casts the notation to a node.

---

DOMProcessingInstruction Subprograms

Table 113-19  Summary of DOMProcessingInstruction Subprograms; DBMS_XMLDOM

Method	Description
GETDATA Functions	Retrieves the data of the processing instruction.
GETTARGET Function	Retrieves the target of the processing instruction.
ISNULL Functions	Tests if the Processing Instruction is NULL.
MAKENODE Functions	Casts the Processing Instruction to a node.
SETDATA Procedures	Sets the data of the processing instruction.

---

DOMText Subprograms

Table 113-20  Summary of DOMText Subprograms; DBMS_XMLDOM

Method	Description
ISNULL Functions	Tests if the text is NULL.
MAKENODE Functions	Casts the text to a node.
SPLITTEXT Function	Splits the contents of the text node into 2 text nodes.

---

Summary of DBMS_XMLDOM Subprograms

Table 113-21  Summary of DBMS_XMLDOM Package Subprogram

Subprogram	Description
ADOPTNODE Procedure	Adopts a node from another document (see DOMNode Subprograms)
APPENDCHILD Function	Appends a new child to the node (see DOMNode Subprograms)
APPENDDATA Procedure	Appends the given data to the node data (see DOMCharacterData Subprograms)
CLONENODE Function	Clones the node (see DOMNode Subprograms)
CREATEATTRIBUTE Functions	Creates an Attribute (see DOMDocument Subprograms)
CREATECDATASECTION Function	Creates a CDataSection node (see DOMDocument Subprograms)
CREATECOMMENT Function	Creates a Comment node (see DOMDocument Subprograms)
CREATEDOCUMENT Function	Creates a new Document (see DOMDocument Subprograms)
CREATEDOCUMENTFRAGMENT Function	Creates a new Document Fragment (see DOMDocument Subprograms)
CREATEELEMENT Functions	Creates a new Element (see DOMDocument Subprograms)
CREATEENTITYREFERENCE Function	Creates an Entity reference (see DOMDocument Subprograms)
CREATEPROCESSINGINSTRUCTION Function	Creates a Processing Instruction (see DOMDocument Subprograms)
CREATETEXTNODE Function	Creates a Text node (see DOMDocument Subprograms)
DELETEDATA Procedure	Deletes the data from the given offSets (see DOMCharacterData Subprograms)
FINDENTITY Function	Finds the specified entity in the document type (see DOMDocumentType Subprograms)
FINDNOTATION Function	Finds the specified notation in the document type (see DOMDocumentType Subprograms)
FREEDOCFRAG Procedure	Frees the document fragment (see DOMDocument Subprograms)
FREEDOCFRAG Procedure	Frees the specified document fragment (see DOMDocumentFragment Subprograms)
FREEDOCUMENT Procedure	Frees the document (see DOMDocument Subprograms)
FREENODE Procedure	Frees all resources associated with the node (see DOMNode Subprograms).
GETATTRIBUTE Functions	Retrieves the attribute node by name (see DOMElement Subprograms)
GETATTRIBUTES Function	Retrieves the attributes of the node (see DOMNode Subprograms)
GETATTRIBUTENODE Functions	Retrieves the attribute node by name (see DOMElement Subprograms)
GETCHILDNODES Function	Retrieves the children of the node (see DOMNode Subprograms
GETCHILDRENBYTAGNAME Functions	Retrieves children of the element by tag name (see DOMCharacterData Subprograms)
GETDATA Functions	Retrieves the data of the node (see DOMCharacterData Subprograms) the data of the processing instruction (see DOMProcessingInstruction Subprograms)
GETDOCTYPE Function	Retrieves the DTD of the document (see DOMDocument Subprograms)
GETDOCUMENTELEMENT Function	Retrieves the root element of the document (see DOMDocument Subprograms)
GETELEMENTSBYTAGNAME Functions	Retrieves the elements in the by tag name (see DOMDocument Subprograms) elements in the subtree by tagname (see DOMElement Subprograms)
GETENTITIES Function	Retrieves the nodemap of entities in the Document type (see DOMDocumentType Subprograms)
GETEXPANDEDNAME Procedure and Functions	Retrieves the expanded name of the node (see DOMNode Subprograms) the expanded name of the attribute (see DOMAttr Subprograms) the expanded name of the element (DOMElement Subprograms)
GETFIRSTCHILD Function	Retrieves the first child of the node (see DOMNode Subprograms)
GETIMPLEMENTATION Function	Retrieves the DOM implementation (DOMDocument Subprograms)
GETLASTCHILD Function	Retrieves the last child of the node (see DOMNode Subprograms)
GETLENGTH Functions	Retrieves the length of the data (see DOMCharacterData Subprograms) the number of items in the map (see DOMNamedNodeMap Subprograms) the number of items in the list (see DOMNodeList Subprograms)
GETLOCALNAME Procedure and Functions	Retrieves the local part of the qualified name (see DOMNode Subprograms) the local name of the attribute (see DOMAttr Subprograms) the local name of the element (see DOMElement Subprograms)
GETNAME Functions	Retrieves the name of the attribute (see DOMAttr Subprograms) the name of the Document type (DOMDocumentType Subprograms)
GETNAMEDITEM Function	Retrieves an item specified by name (see DOMNamedNodeMap Subprograms) an item specified by name and namespace URI (see DOMNamedNodeMap Subprograms)
GETNAMESPACE Procedure and Functions	Retrieves the node's namespace URI (see DOMNode Subprograms) the NS URI of the attribute (see DOMAttr Subprograms) the NS URI of the element (see DOMElement Subprograms)
GETNEXTSIBLING Function	Retrieves the next sibling of the node (see DOMNode Subprograms)
GETNODENAME Function	Retrieves the Name of the Node (see DOMNode Subprograms)
GETNODETYPE Function	Retrieves the Type of the node (see DOMNode Subprograms)
GETNODEVALUE Function	Retrieves the Value of the Node (see DOMNode Subprograms)
GETNOTATIONNAME Function	Retrieves the notation name of the entity (see DOMEntity Subprograms)
GETNOTATIONS Function	Retrieves the nodemap of the notations in the Document type (see DOMDocumentType Subprograms)
GETTARGET Function	Retrieves the target of the processing instruction (see DOMProcessingInstruction Subprograms)
GETOWNERDOCUMENT Function	Retrieves the owner document of the node (see DOMNode Subprograms)
GETOWNERELEMENT Function	Retrieves the Element node, parent of the attribute (see DOMAttr Subprograms)
GETPARENTNODE Function	Retrieves the parent of this node (see DOMNode Subprograms)
GETPREFIX Function	Retrieves the namespace prefix (see DOMNode Subprograms)
GETPREVIOUSSIBLING Function	Retrieves the previous sibling of the node (see DOMNode Subprograms)
GETPUBLICID Functions	Retrieves the public ID of the document type (see DOMDocumentType Subprograms) the public Id of the entity (see DOMEntity Subprograms) the public Id of the notation (see DOMNotation Subprograms)
GETQUALIFIEDNAME Functions	Retrieves the Qualified Name of the attribute (see DOMAttr Subprograms) the qualified name of the element (see DOMElement Subprograms)
GETSCHEMANODE Function	Retrieves the associated schema URI (see DOMNode Subprograms)
GETSPECIFIED Function	Tests if attribute was specified in the element. (see DOMAttr Subprograms)
GETSTANDALONE Function	Retrieves the standalone property of the document (see DOMDocument Subprograms)
GETSYSTEMID Functions	Retrieves the system ID of the document type (see DOMDocumentType Subprograms) the system Id of the entity (see DOMEntity Subprograms) the system Id of the notation (DOMNotation Subprograms)
GETTAGNAME Function	Retrieves the Tag name of the element (see DOMElement Subprograms)
GETVALUE Function	Retrieves the value of the attribute (see DOMAttr Subprograms)
GETVERSION Function	Retrieves the version of the document (DOMDocument Subprograms)
GETXMLTYPE Function	Retrieves the XMLType associated with the DOM Document (see DOMDocument Subprograms)
HASATTRIBUTES Function	Tests if the node has attributes (see DOMNode Subprograms)
HASATTRIBUTE Functions	Tests if an attribute exists (see DOMElement Subprograms)
HASCHILDNODES Function	Tests if the node has child nodes (see DOMNode Subprograms)
HASFEATURE Function	Tests if the DOMImplementation implements a feature (see DOMImplementation Subprograms)
IMPORTNODE Function	Imports a node from another document (see DOMNode Subprograms)
INSERTBEFORE Function	Inserts a child before the reference child (see DOMNode Subprograms)
INSERTDATA Procedure	Inserts the data in the node at the given offSets (see DOMCharacterData Subprograms)
ISNULL Functions	Tests if the node is NULL (see DOMNode Subprograms) if the Attribute node is NULL (see DOMAttr Subprograms) if the CDataSection is NULL (see DOMCDataSection Subprograms) if the CharacterData is NULL (DOMCharacterData Subprograms) if the comment is NULL (see DOMComment Subprograms) if the document is NULL (see DOMDocument Subprograms) if the DocumentFragment is NULL (see DOMDocumentFragment Subprograms) if the Document Type is NULL (see DOMDocumentType Subprograms) if the Element is NULL (see DOMElement Subprograms) if the Entity is NULL (see DOMEntity Subprograms) if the DOMEntityReference is NULL (see DOMEntityReference Subprograms) if the DOMImplementation node is NULL (see DOMImplementation Subprograms)
ISNULL Functions (contd.)	Tests if the NamedNodeMap is NULL (see DOMNamedNodeMap Subprograms) if the NodeList is NULL (see DOMNodeList Subprograms) if the Notation is NULL (see DOMNotation Subprograms) if the Processing Instruction is NULL (DOMProcessingInstruction Subprograms) if the text is NULL (see DOMText Subprograms)
IITEM Functions	Retrieves the item given the index in the map (see DOMNamedNodeMap Subprograms) the item given the index in the NodeList (see DOMNodeList Subprograms)
MAKEATTR Function	Casts the node to an Attribute (see DOMNode Subprograms)
MAKECDATASECTION Function	Casts the node to a CData Section (see DOMNode Subprograms)
MAKECHARACTERDATA Function	Casts the node to Character Data (see DOMNode Subprograms)
MAKECOMMENT Function	Casts the node to a Comment (see DOMNode Subprograms)
MAKEDOCUMENT Function	Casts the node to a DOM Document (see DOMNode Subprograms)
MAKEDOCUMENTFRAGMENT Function	Casts the node to a DOM Document Fragment (see DOMNode Subprograms)
MAKEDOCUMENTTYPE Function	Casts the node to a DOM Document Type (see DOMNode Subprograms)
MAKEELEMENT Function	Casts the node to a DOM Element (see DOMNode Subprograms)
MAKEENTITY Function	Casts the node to a DOM Entity (see DOMNode Subprograms)
MAKEENTITYREFERENCE Function	Casts the node to a DOM Entity Reference (see DOMNode Subprograms)
MAKENODE Functions	Casts the Attribute to a node (see DOMAttr Subprograms) the CDatasection to a node (see DOMCDataSection Subprograms) the CharacterData to a node (see DOMCharacterData Subprograms) the Comment to a node (see DOMComment Subprograms) the document to a node (see DOMDocument Subprograms) the Document Fragment to a node (see DOMDocumentFragment Subprograms) the document type to a node (see DOMDocumentType Subprograms) the Element to a node (see DOMElement Subprograms) the Entity to a node (see DOMEntity Subprograms)
MAKENODE Functions (contd.)	Casts the DOMEntityReference to NULL (see DOMEntityReference Subprograms) the notation to a node (see DOMNotation Subprograms) the Processing Instruction to a node (see DOMProcessingInstruction Subprograms) the text to a node (see DOMText Subprograms)
MAKENOTATION Function	Casts the node to a DOM Notation (see DOMNode Subprograms)
MAKEPROCESSINGINSTRUCTION Function	Casts the node to a DOM Processing Instruction (see DOMNode Subprograms)
MAKETEXT Function	Casts the node to a DOM Text (see DOMNode Subprograms)
NEWDOMDOCUMENT Functions	Creates a new document (see DOMDocument Subprograms)
NORMALIZE Procedure	Normalizes the text children of the element (see DOMElement Subprograms)
REMOVEATTRIBUTE Procedures	Removes the attribute specified by the name (see DOMElement Subprograms)
REMOVEATTRIBUTENODE Function	Removes the attribute node in the element (see DOMElement Subprograms)
REMOVECHILD Function	Removes a specified child from a node (see DOMNode Subprograms)
REMOVENAMEDITEM Function	Removes the item specified by name (see DOMNamedNodeMap Subprograms)
REPLACECHILD Function	Replaces the old child with a new child (see DOMNode Subprograms)
REPLACEDATA Procedure	Changes a range of characters in the node (see DOMCharacterData Subprograms)
RESOLVENAMESPACEPREFIX Function	Resolve the prefix to a namespace URI (see DOMElement Subprograms)
SETATTRIBUTE Procedures	Sets the attribute specified by the name (see DOMElement Subprograms)
SETATTRIBUTENODE Functions	Sets the attribute node in the element (see DOMElement Subprograms)
SETDATA Procedures	Sets the data to the node (see DOMCharacterData Subprograms the data of the processing instruction (see DOMProcessingInstruction Subprograms))
SETNAMEDITEM Function	Sets the item in the map specified by the name (see DOMNamedNodeMap Subprograms)
SETNODEVALUE Procedure	Sets the Value of the node (see DOMNode Subprograms)
SETPREFIX Procedure	Sets the namespace prefix (see DOMNode Subprograms)
SETSTANDALONE Procedure	Sets the standalone property of the document (see DOMDocument Subprograms)
SETVALUE Procedure	Sets the value of the attribute (see DOMAttr Subprograms)
SETVERSION Procedure	Sets the version of the document (see DOMDocument Subprograms)
SPLITTEXT Function	Splits the contents of the text node into 2 text nodes (see DOMText Subprograms)
SUBSTRINGDATA Function	Retrieves the substring of the data (DOMCharacterData Subprograms)
WRITETOBUFFER Procedures	Writes the contents of the node to a buffer (see DOMNode Subprograms) the document to a buffer (see DOMDocument Subprograms) the contents of a document fragment into a buffer (see DOMDocumentFragment Subprograms)
WRITETOCLOB Procedures	Writes the contents of the node to a CLOB (see DOMNode Subprograms) the document to a CLOB (see DOMDocument Subprograms)
WRITETOFILE Procedures	Writes the contents of the node to a file (see DOMNode Subprograms) the document to a file (see DOMDocument Subprograms)

---

ADOPTNODE Procedure

This procedure adopts a node from another document; returns this new node.

Syntax

DBMS_XMLDOM.ADOPTNODE(
   doc            IN   DOMDocument,
   importedNode   IN   DOMNode)
 RETURN DOMNode;

Parameters

Table 113-22 ADOPTNODE Function Parameters

Parameter	Description
doc	Document that is adopting the node.
importedNode	Node to adopt.

---

APPENDCHILD Function

This function adds the node NEWCHILD to the end of the list of children of this node, and returns the newly added node. If the NEWCHILD is already in the tree, it is first removed.

Syntax

DBMS_XMLDOM.APPENDCHILD(
   n          IN    DOMNode,
   newChild   IN    DOMNode)
 RETURN DOMNode;

Parameters

Table 113-23 APPENDCHILD Function Parameters

Parameter	Description
n	DOMNode.
newChild	The child to be appended to the list of children of node n.

---

APPENDDATA Procedure

This procedure appends the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the specified string argument.

Syntax

DBMS_XMLDOM.APPENDDATA(
   cd      IN    DOMCharacterData, 
   arg     IN    VARCHAR2);

Parameters

Table 113-24 APPENDDATA Procedure Parameters

Parameter	Description
cd	DOMCharacterData.
arg	The data to append to the existing data.

---

CLONENODE Function

This function returns a duplicate of this node; serves as a generic copy constructor for nodes. The duplicate node has no parent; its parent node is NULL.

Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning an Attribute directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is TRUE). Cloning any other type of node simply returns a copy of this node.

Syntax

DBMS_XMLDOM.CLONENODE(
   n       IN    DOMNode,
   deep    IN    BOOLEAN)
 RETURN DOMNode;

Parameters

Table 113-25 CLONENODE Function Parameters

Parameter	Description
n	DOMNode.
deep	Determines if children are to be cloned.

---

CREATEATTRIBUTE Functions

This function creates a DOMAttr node.

Syntax

Creates a DOMAttr with the specified name:

DBMS_XMLDOM.CREATEATTRIBUTE(
   doc     IN    DOMDocument,
   name    IN    VARCHAR2)
 RETURN DOMAttr;

Creates a DOMAttr with the specified name and namespace URI:

DBMS_XMLDOM.CREATEATTRIBUTE(
   doc     IN    DOMDocument,
   name    IN    VARCHAR2,
   ns      IN     VARCHAR2)
RETURN DOMAttr;

Parameters

Table 113-26 CREATEATTRIBUTE Function Parameters

Parameter	Description
doc	DOMDocument.
name	New attribute name.
ns	Namespace.

---

CREATECDATASECTION Function

This function creates a DOMCDATASection node.

Syntax

DBMS_XMLDOM.CREATECDATASECTION(
   doc     IN      DOMDocument,
   data    IN      VARCHAR2)
 RETURN DOMCDATASection;

Parameters

Table 113-27 CREATECDATASECTION Function Parameters

Parameter	Description
doc	DOMDocument.
data	Content of the DOMCDATASection node.

---

CREATECOMMENT Function

This function creates a DOMComment node.

Syntax

DBMS_XMLDOM.CREATECOMMENT(
   doc      IN      DOMDocument,
   data     IN      VARCHAR2)
 RETURN DOMComment;

Parameters

Table 113-28 CREATECOMMENT Function Parameters

Parameter	Description
doc	DOMDocument.
data	Content of the DOMComment node.

---

CREATEDOCUMENT Function

This function creates a DOMDocument with specified namespace URI, root element name, DTD.

Syntax

DBMS_XMLDOM.CREATEDOCUMENT(
   namespaceURI      IN     VARCHAR2,
   qualifiedName     IN     VARCHAR2,
   doctype           IN     DOMType:=NULL)
 RETURN DOMDocument;

Parameters

Table 113-29 CREATEDOCUMENT Function Parameters

Parameter	Description
namespaceURI	Namespace URI.
qualifiedName	Root element name.
doctype	Document type.

---

CREATEDOCUMENTFRAGMENT Function

This function creates a DOMDocumentFragment.

Syntax

DBMS_XMLDOM.CREATEDOCUMENTFRAGMENT(
   doc      IN     DOMDocument)
 RETURN DOMDocumentFragment;

Parameters

Table 113-30 CREATEDOCUMENTFRAGMENT Function Parameters

Parameter	Description
doc	DOMDocument.

---

CREATEELEMENT Functions

Creates a DOMElement.

Syntax

Creates a DOMElement with specified name:

DBMS_XMLDOM.CREATEELEMENT(
   doc        IN      DOMDocument,
   tagName    IN      VARCHAR2)
 RETURN DOMElement;

Creates a DOMElement with specified name and namespace URI:

DBMS_XMLDOM.CREATEELEMENT(
   doc        IN     DOMDocument,
   tagName    IN     VARCHAR2,
   ns         IN     VARCHAR2)
 RETURN DOMElement;

Parameters

Table 113-31 CREATEELEMENT Function Parameters

Parameter	Description
doc	DOMDocument.
tagName	Tagname for new DOMElement.
ns	Namespace.

---

CREATEENTITYREFERENCE Function

This function creates a DOMEntityReference node.

Syntax

DBMS_XMLDOM.CREATEENTITYREFERENCE(
   doc        IN     DOMDocument,
   name       IN     VARCHAR2)
 RETURN DOMEntityReference;

Parameters

Table 113-32 CREATEENTITYREFERENCE Function Parameters

Parameter	Description
doc	DOMDocument.
name	New entity reference name.

---

CREATEPROCESSINGINSTRUCTION Function

This function creates a DOMProcessingInstruction node.

Syntax

DBMS_XMLDOM.CREATEPROCESSINGINSTRUCTION(
   doc       IN      DOMDocument,
   target    IN      VARCHAR2,
   data      IN      VARCHAR2)
 RETURN DOMProcessingInstruction;

Parameters

Table 113-33 CREATEPROCESSINGINSTRUCTION Function Parameters

Parameter	Description
doc	DOMDocument.
target	Target of the new processing instruction.
data	Content data of the new processing instruction.

---

CREATETEXTNODE Function

This function creates a DOMText node.

Syntax

DBMS_XMLDOM.CREATETEXTNODE(
   doc      IN     DOMDocument,
   data     IN     VARCHAR2)
 RETURN DOMText;

Parameters

Table 113-34 CREATETEXTNODE Function Parameters

Parameter	Description
doc	DOMDocument.
data	Content of the DOMText node.

---

DELETEDATA Procedure

This procedure removes a range of characters from the node. Upon success, data and length reflect the change.

Syntax

DBMS_XMLDOM.DELETEDATA(
   cd        IN     DOMCharacterData,
   offset    IN     NUMBER,
   cnt       IN     NUMBER);

Parameters

Table 113-35 DELETEDATA PROCEDURE Parameters

Parameter	Description
cd	DOMCharacterData.
offset	The offset from which to delete the data.
cnt	The number of characters (starting from offset) to delete.

---

FINDENTITY Function

This function finds an entity in the given DTD; returns that entity if found.

Syntax

DBMS_XMLDOM.FINDENTITY(
   dt     IN     DOMDocumentType,
   name   IN     VARCHAR2,
   par    IN     BOOLEAN) 
 RETURN  DOMEntity;

Parameters

Table 113-36 FINDENTITY Function Parameters

Parameter	Description
dt	The DTD.
name	Entity to find.
par	Flag to indicate type of entity; TRUE for parameter entity and FALSE for normal entity.

---

FINDNOTATION Function

This function finds the notation in the given DTD; returns it, if found.

Syntax

DBMS_XMLDOM.FINDNOTATION(
   dt        IN     DOMDocumentType,
   name      IN     VARCHAR2) 
 RETURN DOMNotation;

Parameters

Table 113-37 FINDNOTATION Function Parameters

Parameter	Description
dt	The DTD.
name	The notation to find.

---

FREEDOCFRAG Procedure

This procedure frees the specified document fragment.

Syntax

DBMS_XMLDOM.FREEDOCFRAG(
   df    IN    DOMDocumentFragment);

Parameters

Table 113-38 FREEDOCFRAG Procedure Parameters

Parameter	Description
df	DOM document fragment.

---

FREEDOCFRAG Procedure

This procedure frees the specified document fragment.

Syntax

DBMS_XMLDOM.FREEDOCFRAG(
   df    IN   DOMDocumentFragment);

Parameters

Table 113-39 FREEDOCFRAG Procedure Parameters

Parameter	Description
df	DOM document fragment.

---

FREEDOCUMENT Procedure

This procedure frees DOMDocument object.

Syntax

DBMS_XMLDOM.FREEDOCUMENT(
   doc     IN     DOMDocument);

Parameters

Table 113-40 FREEDOCUMENT Procedure Parameters

Parameter	Description
doc	DOMDocument.

---

FREENODE Procedure

This procedure frees all resources associated with a Node.

Syntax

DBMS_XMLDOM.FREENODE(
   n      IN     DOMNode);

Parameters

Table 113-41 FREENODE Procedure Parameters

Parameter	Description
n	DOMNode.

---

GETATTRIBUTE Functions

Returns the value of a DOMElement's attribute by name.

Syntax

Returns the value of a DOMElement's attribute by name:

DBMS_XMLDOM.GETATTRIBUTE(
   elem       IN      DOMElement,
   name       IN      VARCHAR2)
 RETURN VARCHAR2;

Returns the value of a DOMElement's attribute by name and namespace URI:

DBMS_XMLDOM.GETATTRIBUTE(
   elem      IN     DOMElement,
   name      IN     VARCHAR2,
   ns        IN     VARCHAR2)
 RETURN VARCHAR2;

Parameters

Table 113-42 GETATTRIBUTE Function Parameters

Parameter	Description
elem	The DOMElement.
name	Attribute name.
ns	Namespace.

---

GETATTRIBUTES Function

This function retrieves a NamedNodeMap containing the attributes of this node (if it is an Element) or NULL otherwise.

Syntax

DBMS_XMLDOM.GETATTRIBUTES(
   n      IN      DOMNode)
 RETURN DOMNamedNodeMap;

Parameters

Table 113-43 GETATTRIBUTES Function Parameters

Parameter	Description
n	DOMNode.

---

GETATTRIBUTENODE Functions

Returns an attribute node from the DOMElement by name.

Syntax

Returns an attribute node from the DOMElement by name:

DBMS_XMLDOM.GETATTRIBUTENODE(
   elem      IN     DOMElement,
   name      IN     VARCHAR2)
 RETURN DOMAttr;

Returns an attribute node from the DOMElement by name and namespace URI:

DBMS_XMLDOM.GETATTRIBUTENODE(
   elem      IN     DOMElement,
   name      IN     VARCHAR2,
   ns        IN     VARCHAR2)
RETURN DOMAttr;

Parameters

Table 113-44 GETATTRIBUTENODE Function Parameters

Parameter	Description
elem	The DOMElement.
name	Attribute name; * matches any attribute.
ns	Namespace.

---

GETCHILDNODES Function

This function retrieves a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

Syntax

DBMS_XMLDOM.GETCHILDNODES(
   n      IN    DOMNode)
 RETURN DOMNodeList;

Parameters

Table 113-45 GETCHILDNODES Function Parameters

Parameter	Description
n	DOMNode.

---

GETCHILDRENBYTAGNAME Functions

Returns the children of the DOMElement.

Syntax

Returns children of the DOMElement given the tag name:

DBMS_XMLDOM.GETCHILDRENBYTAGNAME(
   elem      IN      DOMElement, 
   name      IN      VARCHAR2) 
 RETURN DOMNodeList;

Returns children of the DOMElement given the tag name and namespace:

DBMS_XMLDOM.GETCHILDRENBYTAGNAME(
   elem      IN      DOMElement, 
   name      IN      VARCHAR2, 
   ns        IN      VARCHAR2) 
RETURN DOMNodeList;

Parameters

Table 113-46 GETCHILDRENBYTAGNAME Function Parameters

Parameter	Description
elem	The DOMElement.
name	Tag name.
ns	Namespace.

---

GETDATA Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Gets the character data of the node that implements this interface (See Also: DOMCharacterData Subprograms):

DBMS_XMLDOM.GETDATA(
   cd      IN    DOMCharacterData)
 RETURN VARCHAR2;

Returns the content data of the DOMProcessingInstruction (See Also: DOMProcessingInstruction Subprograms):

DBMS_XMLDOM.GETDATA(
   pi      IN    DOMProcessingInstruction)
 RETURN VARCHAR2;

Parameters

Table 113-47 GETDATA Function Parameters

Parameter	Description
cd	DOMCharacterData.
pi	The DOMProcessingInstruction.

---

GETDOCTYPE Function

This function returns the DTD associated to the DOMDocument.

Syntax

DBMS_XMLDOM.GETDOCTYPE(
   doc      IN     DOMDocument)
RETURN domdocumenttype;

Parameters

Table 113-48 GETDOCTYPE Function Parameters

Parameter	Description
doc	DOMDocument.

---

GETDOCUMENTELEMENT Function

This function returns the root element of the DOMDocument.

Syntax

DBMS_XMLDOM.GETDOCUMENTELEMENT(
   doc      IN      DOMDocument)
 RETURN DOMElement;

Parameters

Table 113-49 GETDOCUMENTELEMENT Function Parameters

Parameter	Description
doc	DOMDocument.

---

GETELEMENTSBYTAGNAME Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Returns a DOMNodeList of all the elements with a given tagname (See Also: DOMDocument Subprograms):

DBMS_XMLDOM.GETELEMENTSBYTAGNAME(
   doc         IN      DOMDocument,
   tagname     IN      VARCHAR2)
 RETURN DOMNodeList;

Returns the element children of the DOMElement given the tag name (See Also: DOMElement Subprograms):

DBMS_XMLDOM.GETELEMENTSBYTAGNAME(
   elem      IN     DOMElement,
   name      IN     VARCHAR2) 
 RETURN DOMNodeList;

Returns the element children of the DOMElement given the tag name and namespace (See Also: DOMElement Subprograms):

DBMS_XMLDOM.GETELEMENTSBYTAGNAME(
   elem      IN     DOMElement,
   name      IN     VARCHAR2, 
   ns        IN     VARCHAR2) 
 RETURN DOMNodeList;

Parameters

Table 113-50  GETELEMENTSBYTAGNAME Function Parameters

Parameter	Description
doc	DOMDocument.
tagname	Name of the tag to match on.
elem	The DOMElement.
name	Tag name; using a wildcard(*) would match any tag.
ns	Namespace.

---

GETENTITIES Function

This function retrieves a NamedNodeMap containing the general entities, both external and internal, declared in the DTD.

Syntax

DBMS_XMLDOM.GETENTITIES(
   dt      IN     DOMDocumentType)
 RETURN DOMNamedNodeMap;

Parameters

Table 113-51

Parameter	Description
dt	DOMDocumentType.

---

GETEXPANDEDNAME Procedure and Functions

GETEXPANDEDNAME is overloaded as a procedure and two functions. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Retrieves the expanded name of the Node if is in an Element or Attribute type; otherwise, returns NULL (See Also: DOMNode Subprograms)

DBMS_XMLDOM.GETEXPANDEDNAME(
   n       IN      DOMNode
   data    OUT     VARCHAR);

Returns the expanded name of the DOMAttr (See Also: DOMAttr Subprograms):

DBMS_XMLDOM.GETEXPANDEDNAME(
   a       IN     DOMAttr)
 RETURN VARCHAR2;

Returns the expanded name of the DOMElement (See Also: DOMElement Subprograms):

DBMS_XMLDOM.GETEXPANDEDNAME(
   elem      IN    DOMElement)
 RETURN VARCHAR2;

Parameters

Table 113-52 GETEXPANDEDNAME Procedure and Function Parameters

Parameter	Description
n	DOMNode.
data	Returned expanded name of the Node.
a	DOMAttr.
elem	DOMElement.

---

GETFIRSTCHILD Function

This function retrieves the first child of this node. If there is no such node, this returns NULL.

Syntax

DBMS_XMLDOM.GETFIRSTCHILD(
   n      IN      DOMNode)
 RETURN DOMNode;

Parameters

Table 113-53 GETFIRSTCHILD Function Parameters

Parameter	Description
n	DOMNode.

---

GETIMPLEMENTATION Function

This function returns the DOMImplementation object that handles this DOMDocument.

Syntax

DBMS_XMLDOM.GETIMPLEMENTATION(
   doc      IN     DOMDocument)
 RETURN DOMImplementation;

Parameters

Table 113-54 GETIMPLEMENTATION Function Parameters

Parameter	Description
doc	DOMDocument.

---

GETLASTCHILD Function

This function retrieves the last child of this node. If there is no such node, this returns NULL.

Syntax

DBMS_XMLDOM.GETLASTCHILD(
   n     IN   DOMNode)
 RETURN DOMNode;

Parameters

Table 113-55 GETLASTCHILD Function Parameters

Parameter	Description
n	DOMNode.

---

GETLENGTH Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Gets the number of characters in the data. This may have the value zero, because CharacterData nodes may be empty (See Also: DOMCharacterData Subprograms):

DBMS_XMLDOM.GETLENGTH(
   cd     IN     DOMCharacterData)
 RETURN NUMBER;

Gets the number of nodes in this map. The range of valid child node indexes is 0 to length-1, inclusive (See Also: DOMNamedNodeMap Subprograms):

DBMS_XMLDOM.GETLENGTH(
   nnm      IN     DOMNamedNodeMap)
 RETURN NUMBER;

Gets the number of nodes in the list. The range of valid child node indexes is 0 to length-1, inclusive (See Also: DOMNodeList Subprograms):

DBMS_XMLDOM.GETLENGTH(
   nl     IN    DOMNodeList)
 RETURN NUMBER;

Parameters

Table 113-56 GETLENGTH Function Parameters

Parameter	Description
cd	DOMCharacterData.
nnm	DOMNamedNodeMap.
nl	DOMNodeList.

---

GETLOCALNAME Procedure and Functions

This function is overloaded as a procedure and two functions. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Retrieves the local part of the node's qualified name (See Also: DOMNode Subprograms):

DBMS_XMLDOM.GETLOCALNAME(
   n       IN     DOMNode,
   data    OUT    VARCHAR2);

Returns the local name of the DOMAttr (See Also: DOMAttr Subprograms):

DBMS_XMLDOM.GETLOCALNAME(
   a       IN     DOMAttr)
 RETURN VARCHAR2;

Returns the local name of the DOMElement (See Also: DOMElement Subprograms)

DBMS_XMLDOM.GETLOCALNAME(
   elem       IN     DOMElement)
 RETURN VARCHAR2;

Parameters

Table 113-57 GETLOCALNAME Procedure and Function Parameters

Parameter	Description
n	DOMNode
data	Returned local name.
a	DOMAttr.
elem	DOMElement.

---

GETNAME Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Returns the name of this attribute (See Also: DOMAttr Subprograms):

DBMS_XMLDOM.GETNAME(
   a       IN     DOMAttr)
 RETURN VARCHAR2;

Retrieves the name of DTD, or the name immediately following the DOCTYPE keyword (See Also: DOMDocumentType Subprograms):

DBMS_XMLDOM.GETNAME(
   dt       IN     DOMDocumentType)
 RETURN VARCHAR2;

Parameters

Table 113-58 GETNAME Function Parameters

Parameter	Description
a	DOMAttr.
dt	DOMDocumentType.

---

GETNAMEDITEM Function

This function retrieves a node specified by name.

Syntax

Retrieves a node specified by name:

DBMS_XMLDOM.GETNAMEDITEM(
   nnm DOMNamedNodeMap,
   name IN VARCHAR2)
 RETURN DOMNode;

Retrieves a node specified by name and namespace URI:

DBMS_XMLDOM.GETNAMEDITEM(
   nnm DOMNamedNodeMap,
   name IN VARCHAR2,
   ns IN VARCHAR2)
RETURN DOMNode;

Parameters

Table 113-59 GETNAMEDITEM Function Parameters

Parameter	Description
nnm	DOMNamedNodeMap.
name	Name of the item to be retrieved.
ns	Namespace.

---

GETNAMESPACE Procedure and Functions

GETNAMESPACE is overloaded as a procedure and two functions. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Retrieves the namespace URI associated with the node (See Also: DOMNode Subprograms):

DBMS_XMLDOM.GETNAMESPACE(
   n       IN     DOMNode,
   data    OUT    VARCHAR2);

Retrieves the namespace of the DOMAttr (See Also: DOMAttr Subprograms):

DBMS_XMLDOM.GETNAMESPACE(
   a       IN     DOMAttr)
 RETURN VARCHAR2;

Retrieves the namespace of the DOMElement (See Also: DOMElement Subprograms):

DBMS_XMLDOM.GETNAMESPACE(
   elem       IN     DOMElement)
 RETURN VARCHAR2;

Parameters

Table 113-60 GETNAMESPACE Procedure and Function Parameters

Parameter	Description
n	DOMNode.
data	Returned namespace URI.
a	DOMAttr.
elem	DOMElement.

---

GETNEXTSIBLING Function

This function retrieves the node immediately following this node. If there is no such node, this returns NULL.

Syntax

DBMS_XMLDOM.GETNEXTSIBLING(
   n       IN     DOMNode)
 RETURN DOMNode;

Parameters

Table 113-61 GETNEXTSIBLING Function Parameters

Parameter	Description
n	DOMNode.

---

GETNODENAME Function

This function gets the name of the node depending on its type.

Syntax

DBMS_XMLDOM.GETNODENAME(
   n       IN     DOMNode)
RETURN VARCHAR2;

Parameters

Table 113-62 GETNODENAME Function Parameters

Parameter	Description
n	DOMNode.

---

GETNODETYPE Function

This function retrieves a code representing the type of the underlying object.

Syntax

DBMS_XMLDOM.GETNODETYPE(
   n       IN     DOMNode)
 RETURN NUMBER;

Parameters

Table 113-63 GETNODETYPE Function Parameters

Parameter	Description
n	DOMNode.

---

GETNODEVALUE Function

This function gets the value of this node, depending on its type.

Syntax

DBMS_XMLDOM.GETNODEVALUE(
   n       IN     DOMNode)
 RETURN VARCHAR2;

Parameters

Table 113-64 GETNODEVALUE Function Parameters

Parameter	Description
n	DOMNode.

---

GETNOTATIONNAME Function

This function returns the notation name of the DOMEntity.

Syntax

DBMS_XMLDOM.GETNOTATIONNAME(
   ent       IN     DOMEntity)
 RETURN VARCHAR2;

Parameters

Table 113-65 GETNOTATIONNAME Function Parameters

Parameter	Description
ent	DOMEntity.

---

GETNOTATIONS Function

This function retrieves a NamedNodeMap containing the notations declared in the DTD.

Syntax

DBMS_XMLDOM.GETNOTATIONS(
   dt       IN     DOMDocumentType)
 RETURN DOMNamedNodeMap;

Parameters

Table 113-66 GETNOTATIONS Function Parameters

Parameter	Description
dt	DOMDocumentType.

---

GETTARGET Function

This function returns the target of the DOMProcessingInstruction.

Syntax

DBMS_XMLDOM.GETTARGET(
   pi       IN     DOMProcessingInstruction)
 RETURN VARCHAR2;

Parameters

Table 113-67 GETTARGET Function Parameters

Parameter	Description
pi	DOMProcessingInstruction.

---

GETOWNERDOCUMENT Function

This function retrieves 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 Document Type that is not used with any Document yet, this is NULL.

Syntax

DBMS_XMLDOM.GETOWNERDOCUMENT(
   n       IN     DOMNode)
 RETURN DOMDocument;

Parameters

Table 113-68 GETOWNERDOCUMENT Function Parameters

Parameter	Description
n	DOMNode.

---

GETOWNERELEMENT Function

This function retrieves the Element node to which the specified Attribute is attached.

Syntax

DBMS_XMLDOM.GETOWNERELEMENT(
   a       IN     DOMAttr)
 RETURN DOMElement;

Parameters

Table 113-69 GETOWNERELEMENT Function Parameters

Parameter	Description
a	Attribute.

---

GETPARENTNODE Function

This function retrieves 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.

Syntax

DBMS_XMLDOM.GETPARENTNODE(
   n       IN     DOMNode)
 RETURN DOMNode;

Parameters

Table 113-70 GETPARENTNODE Function Parameters

Parameter	Description
n	DOMNode.

---

GETPREFIX Function

This function retrieves the namespace prefix of the node.

Syntax

DBMS_XMLDOM.GETPREFIX(
   n       IN     DOMNode)
 RETURN VARCHAR2;

Parameters

Table 113-71 GETPREFIX Function Parameters

Parameter	Description
n	DOMNode.

---

GETPREVIOUSSIBLING Function

This function retrieves the node immediately preceding this node. If there is no such node, this returns NULL.

Syntax

DBMS_XMLDOM.GETPREVIOUSSIBLING(
   n       IN     DOMNode)
 RETURN DOMNode;

Parameters

Table 113-72 GETPREVIOUSSIBLING Function Parameters

Parameter	Description
n	DOMNode.

---

GETPUBLICID Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Returns the public identifier of the given DTD (See Also: DOMDocumentType Subprograms):

DBMS_XMLDOM.GETPUBLICID(
   dt       IN     DOMDocumentType)
 RETURN VARCHAR2;

Returns the public identifier of the DOMEntity (See Also: DOMEntity Subprograms):

DBMS_XMLDOM.GETPUBLICID(
   ent      IN     DOMEntity)
 RETURN VARCHAR2;

Returns the public identifier of the DOMNotation (See Also: DOMNotation Subprograms):

DBMS_XMLDOM.GETPUBLICID(
   n        IN     DOMNotation)
 RETURN VARCHAR2;

Parameters

Table 113-73  GETPUBLICID Function Parameters

Parameter	Description
dt	The DTD.
ent	DOMEntity.
n	DOMNotation.

---

GETQUALIFIEDNAME Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Returns the qualified name of the DOMAttr (See Also: DOMAttr Subprograms):

DBMS_XMLDOM.GETQUALIFIEDNAME(
   a       IN     DOMAttr)
 RETURN VARCHAR2;

Returns the qualified name of the DOMElement (See Also: DOMElement Subprograms):

DBMS_XMLDOM.GETQUALIFIEDNAME(
   elem       IN     DOMElement)
 RETURN VARCHAR2;

Parameters

Table 113-74 GETQUALIFIEDNAME Functions Parameters

Parameter	Description
a	DOMAttr.
elem	DOMElement.

---

GETSCHEMANODE Function

This function retrieves the schema URI associated with the node.

Syntax

DBMS_XMLDOM.GETSCHEMANODE(
   n       IN     DOMNode)
 RETURN DOMNode;

Parameters

Table 113-75 GETSCHEMANODE Function Parameters

Parameter	Description
n	DOMNode.

---

GETSPECIFIED Function

If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false.

Syntax

DBMS_XMLDOM.GETSPECIFIED(
   a       IN     DOMAttr)
 RETURN BOOLEAN;

Parameters

Table 113-76 GETSPECIFIED Function Parameters

Parameter	Description
a	DOMAttr.

---

GETSTANDALONE Function

This function returns the standalone property associated with the DOMDocument.

Syntax

DBMS_XMLDOM.GETSTANDALONE(
   doc       IN     DOMDocument)
 RETURN VARCHAR2;

Parameters

Table 113-77 GETSTANDALONE Function Parameters

Parameter	Description
doc	DOMDocument.

---

GETSYSTEMID Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Returns the system id of the given DTD (See Also: DOMDocumentType Subprograms):

DBMS_XMLDOM.GETSYSTEMID(
   dt       IN     DOMDocumentType)
 RETURN VARCHAR2;

Returns the system identifier of the DOMEntity (See Also: DOMEntity Subprograms):

DBMS_XMLDOM.GETSYSTEMID(
   ent      IN     DOMEntity)
 RETURN VARCHAR2;

Returns the system identifier of the DOMNotation (See Also: DOMNotation Subprograms):

DBMS_XMLDOM.GETSYSTEMID(
   n        IN     DOMNotation)
 RETURN VARCHAR2;

Parameters

Table 113-78 GETSYSTEMID Function Parameters

Parameter	Description
dt	The DTD.
ent	DOMEntity.
n	DOMNotation.

---

GETTAGNAME Function

This function returns the name of the DOMElement.

Syntax

DBMS_XMLDOM.GETTAGNAME(
   elem       IN     DOMElement)
 RETURN VARCHAR2;

Parameters

Table 113-79 GETTAGNAME Function Parameters

Parameter	Description
elem	The DOMElement.

---

GETVALUE Function

This function retrieves the value of the attribute.

Syntax

DBMS_XMLDOM.GETVALUE(
   a       IN     DOMAttr)
 RETURN VARCHAR2;

Parameters

Table 113-80 GETVALUE Function Parameters

Parameter	Description
a	DOMAttr.

---

GETVERSION Function

This function returns the version of the DOMDocument.

Syntax

DBMS_XMLDOM.GETVERSION(
   doc       IN     DOMDocument)
 RETURN VARCHAR2;

Parameters

Table 113-81 GETVERSION Function Parameters

Parameter	Description
doc	DOMDocument.

---

GETXMLTYPE Function

This function returns the XMLType associated with the DOMDocument.

Syntax

DBMS_XMLDOM.GETXMLTYPE(
   doc       IN     DOMDocument)
 RETURN SYS.XMLType;

Parameters

Table 113-82 GETXMLTYPE Function Parameters

Parameter	Description
doc	DOMDocument.

---

HASATTRIBUTE Functions

Verifies whether an attribute has been defined for DOMElement, or has a default value.

Syntax

Verifies whether an attribute with the specified name has been defined for DOMElement:

DBMS_XMLDOM.HASATTRIBUTE(
   elem       IN     DOMElement,
   name       IN VARCHAR2)
 RETURN VARCHAR2;

Verifies whether an attribute with specified name and namespace URI has been defined for DOMElement; namespace enabled:

DBMS_XMLDOM.HASATTRIBUTE(
   elem       IN     DOMElement,
   name IN VARCHAR2,
   ns IN VARCHAR2)
 RETURN VARCHAR2;

Parameters

Table 113-83 HASATTRIBUTE Function Parameters

Parameter	Description
elem	The DOMElement.
name	Attribute name; * matches any attribute.
ns	Namespace.

---

HASATTRIBUTES Function

This function returns whether this node has any attributes.

Syntax

DBMS_XMLDOM.HASATTRIBUTES(
   n       IN     DOMNode)
 RETURN BOOLEAN;

Parameters

Table 113-84 HASATTRIBUTES Function Parameters

Parameter	Description
n	DOMNode.

---

HASCHILDNODES Function

This function determines whether this node has any children.

Syntax

DBMS_XMLDOM.HASCHILDNODES(
   n       IN     DOMNode)
 RETURN BOOLEAN;

Parameters

Table 113-85 HASCHILDNODES Function Parameters

Parameter	Description
n	DOMNode.

---

HASFEATURE Function

This function tests if the DOMImplementation implements a specific feature.

Syntax

DBMS_XMLDOM.HASFEATURE(
   di       IN     OMImplementation,
   feature  IN     VARCHAR2,
   version  IN     VARCHAR2)
 RETURN BOOLEAN;

Parameters

Table 113-86 HASFEATURE Function Parameters

Parameter	Description
di	DOMImplementation.
feature	The feature to check for.
version	The version of the DOM to check in.

---

IMPORTNODE Function

This function imports a node from an external document and returns this new node.

Syntax

DBMS_XMLDOM.IMPORTNODE(
   doc            IN     DOMDocument,
   importedNode   IN     DOMNode,
   deep           IN     BOOLEAN)
  RETURN DOMNode;

Parameters

Table 113-87 IMPORTNODE Function Parameters

Parameter	Description
doc	Document from which the node is imported.
importedNode	Node to import.
deep	Setting for recursive import. If this value is TRUE, the entire subtree of the node will be imported with the node. If this value is FALSE, only the node itself will be imported.

---

INSERTBEFORE Function

This function 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.

Syntax

DBMS_XMLDOM.INSERTBEFORE(
   n          IN     DOMNode,
   newChild   IN     DOMNode,
   refChild   IN     DOMNode)
  RETURN DOMNode;

Parameters

Table 113-88 INSERTBEFORE Function Parameters

Parameter	Description
n	DOMNode.
newChild	The child to be inserted in the DOMNode.
refChild	The reference node before which the NEWCHILD is to be inserted.

---

INSERTDATA Procedure

This procedure inserts a string at the specified character offset.

Syntax

DBMS_XMLDOM.INSERTDATA(
   cd       IN     DOMCharacterData,
   offset   IN     NUMBER,
   arg      IN     VARCHAR2);

Parameters

Table 113-89 INSERTDATA Procedure Parameters

Parameter	Description
cd	DOMCharacterData.
offset	The offset at which to insert the data.
arg	The value to be inserted.

---

ISNULL Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Checks if the given DOMNode is NULL. Returns TRUE if it is NULL, FALSE otherwise (See Also: DOMNode Subprograms):

DBMS_XMLDOM.ISNULL(
  n        IN     DOMNode) 
 RETURN BOOLEAN;

Checks that the given DOMAttr is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMAttr Subprograms):

DBMS_XMLDOM.ISNULL(
   a       IN     DOMAttr)
 RETURN BOOLEAN;

Checks that the given DOMCDataSection is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMCDataSection Subprograms):

DBMS_XMLDOM.ISNULL(
   cds      IN     DOMCDataSection)
 RETURN BOOLEAN;

Checks that the given DOMCharacterData is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMCharacterData Subprograms):

DBMS_XMLDOM.ISNULL(
   cd       IN     DOMCharacterData)
 RETURN BOOLEAN;

Checks that the given DOMComment is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMComment Subprograms):

DBMS_XMLDOM.ISNULL(
   com       IN     DOMComment)
 RETURN BOOLEAN;

Checks that the given DOMDocument is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMDocument Subprograms):

DBMS_XMLDOM.ISNULL(
   doc       IN     DOMDocument)
 RETURN BOOLEAN;

Checks that the given DOMDocumentFragment is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMDocumentFragment Subprograms):

DBMS_XMLDOM.ISNULL(
   df       IN     DOMDocumentFragment)
 RETURN BOOLEAN;

Checks that the given DOMDocumentType is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMDocumentType Subprograms):

DBMS_XMLDOM.ISNULL(
   dt       IN     DOMDocumentType)
 RETURN BOOLEAN;

Checks that the given DOMElement is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMElement Subprograms):

DBMS_XMLDOM.ISNULL(
   elem     IN     DOMElement)
 RETURN BOOLEAN;

Checks that the given DOMEntity is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMEntity Subprograms):

DBMS_XMLDOM.ISNULL(
   ent       IN     DOMEntity)
 RETURN BOOLEAN;

Checks that the given DOMEntityReference is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMEntityReference Subprograms):

DBMS_XMLDOM.ISNULL(
   eref       IN     DOMEntityReference)
 RETURN BOOLEAN;

Checks that the DOMImplementation is NULL; returns TRUE if it is NULL (See Also: DOMImplementation Subprograms):

DBMS_XMLDOM.ISNULL(
   di       IN     DOMImplementation)
 RETURN BOOLEAN;

Checks that the given DOMNamedNodeMap is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMNamedNodeMap Subprograms):

DBMS_XMLDOM.ISNULL(
   nnm       IN     DOMNamedNodeMap)
 RETURN BOOLEAN;

Checks that the given DOMNodeList is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMNodeList Subprograms):

DBMS_XMLDOM.ISNULL(
   nl       IN     DOMNodeList)
 RETURN BOOLEAN;

Checks that the given DOMNotation is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMNotation Subprograms):

DBMS_XMLDOM.ISNULL(
   n       IN     DOMNotation)
 RETURN BOOLEAN;

Checks that the given DOMProcessingInstruction is NULL; returns TRUE if it is (See Also: DOMProcessingInstruction Subprograms):

DBMS_XMLDOM.ISNULL(
   pi       IN     DOMProcessingInstruction)
 RETURN BOOLEAN;

Checks that the given DOMText is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMText Subprograms):

DBMS_XMLDOM.ISNULL(
   t       IN     DOMText)
 RETURN BOOLEAN;

Parameters

Table 113-90  ISNULL Function Parameters

Parameter	Description
n	DOMNode to check.
a	DOMAttr to check.
cds	DOMCDataSection to check.
cd	DOMCharacterData to check.
com	DOMComment to check.
doc	DOMDocument to check.
dF	DOMDocumentFragment to check.
dt	DOMDocumentType to check.
elem	DOMElement to check.
ent	DOMEntity to check.
eref	DOMEntityReference to check.
di	DOMImplementation to check.
nnm	DOMNameNodeMap to check.
nl	DOMNodeList to check.
n	DOMNotation to check.
pi	DOMProcessingInstruction to check.
t	DOMText to check.

---

IITEM Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Returns the item in the map which corresponds to the INDEX parameter. If INDEX is greater than or equal to the number of nodes in this map, this returns NULL (See Also: DOMNamedNodeMap Subprograms):

DBMS_XMLDOM.ITEM(
   nnm       IN     DOMNamedNodeMap,
   index     IN     NUMBER)
 RETURN DOMNode;

Returns the item in the collection which corresponds to the INDEX parameter. If index is greater than or equal to the number of nodes in the list, this returns NULL (See Also: DOMNodeList Subprograms):

DBMS_XMLDOM.ITEM(
   nl       IN     DOMNodeList,
   index    IN     NUMBER)
 RETURN DOMNode;

Parameters

Table 113-91 ITEM Function Parameters

Parameter	Description
nnm	DOMNamedNodeMap.
index	The index in the node map at which the item is to be retrieved.
nl	DOMNodeList
index	The index in the NodeList used to retrieve the item.

---

MAKEATTR Function

This function casts a given DOMNode to a DOMAttr, and returns the DOMAttr.

Syntax

DBMS_XMLDOM.MAKEATTR(
   n       IN     DOMNode)
 RETURN DOMAttr;

Parameters

Table 113-92 MAKEATTR Function Parameters

Parameter	Description
n	DOMNode to cast

---

MAKECDATASECTION Function

This function casts a given DOMNode to a DOMCDataSection.

Syntax

DBMS_XMLDOM.MAKECDATASECTION(
   n       IN     DOMNode)
 RETURN DOMCDataSection;

Parameters

Table 113-93 MAKECDATASECTION Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKECHARACTERDATA Function

This function casts a given DOMNode to a DOMCharacterData, and returns the DOMCharacterData.

Syntax

DBMS_XMLDOM.MAKECHARACTERDATA(
   n       IN     DOMNode)
 RETURN DOMCharacterData;

Parameters

Table 113-94 MAKECHARACTERDATA Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKECOMMENT Function

This function casts a given DOMNode to a DOMComment, and returns the DOMComment.

Syntax

DBMS_XMLDOM.MAKECOMMENT(
   n       IN     DOMNode)
 RETURN DOMComment;

Parameters

Table 113-95 MAKECOMMENT Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKEDOCUMENT Function

This function casts a given DOMNode to a DOMDocument, and returns the DOMDocument.

Syntax

DBMS_XMLDOM.MAKEDOCUMENT(
   n       IN     DOMNode)
 RETURN DOMDocument;

Parameters

Table 113-96 MAKEDOCUMENT Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKEDOCUMENTFRAGMENT Function

This function casts a given DOMNode to a DOMDocumentFragment, and returns the DOMDocumentFragment.

Syntax

DBMS_XMLDOM.MAKEDOCUMENTFRAGMENT(
   n       IN     DOMNode)
 RETURN DOMDocumentFragment;

Parameters

Table 113-97 MAKEDOCUMENTFRAGMENT Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKEDOCUMENTTYPE Function

This function casts a given DOMNode to a DOMDocumentType and returns the DOMDocumentType.

Syntax

DBMS_XMLDOM.MAKEDOCUMENTTYPE(
   n       IN     DOMNode)
 RETURN DOMDocumentType;

Parameters

Table 113-98 MAKEDOCUMENTTYPE Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKEELEMENT Function

This function casts a given DOMNode to a DOMElement, and returns the DOMElement.

Syntax

DBMS_XMLDOM.MAKEELEMENT(
   n       IN     DOMNode)
 RETURN DOMElement;

Parameters

Table 113-99 MAKEELEMENT Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKEENTITY Function

This function casts a given DOMNode to a DOMEntity, and returns the DOMEntity.

Syntax

DBMS_XMLDOM.MAKEENTITY(
   n       IN     DOMNode)
 RETURN DOMEntity;

Parameters

Table 113-100 MAKEENTITY Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKEENTITYREFERENCE Function

This function casts a given DOMNode to a DOMEntityReference, and returns the DOMEntityReference.

Syntax

DBMS_XMLDOM.MAKEENTITYREFERENCE(
   n       IN     DOMNode)
 RETURN DOMEntityReference;

Parameters

Table 113-101 MAKEENTITYREFERENCE Function Parameters

Parameter	Description
n	DOMNode to cast.

---

MAKENODE Functions

This function is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Casts given DOMAttr to a DOMNode, and returns the DOMNode (See Also: DOMAttr Subprograms):

DBMS_XMLDOM.MAKENODE(
   a        IN     DOMAttr)
 RETURN DOMNode;

Casts the DOMCDataSection to a DOMNode, and returns that DOMNode (See Also: DOMCDataSection Subprograms):

DBMS_XMLDOM.MAKENODE(
   cds      IN     DOMCDataSection)
 RETURN DOMNode;

Casts the given DOMCharacterData as a DOMNode, and returns that DOMNode (See Also: DOMCharacterData Subprograms):

DBMS_XMLDOM.MAKENODE(
   cd       IN     DOMCharacterData)
 RETURN DOMNode;

Casts the given DOMComment to a DOMNode, and returns that DOMNode (See Also: DOMComment Subprograms):

DBMS_XMLDOM.MAKENODE(
   com      IN     DOMComment)
 RETURN DOMNode;

Casts the DOMDocument to a DOMNode, and returns that DOMNode (See Also: DOMDocument Subprograms):

DBMS_XMLDOM.MAKENODE(
   doc      IN     DOMDocument)
 RETURN DOMNode;

Casts the given DOMDocumentFragment to a DOMNode, and returns that DOMNode (See Also: DOMDocumentFragment Subprograms):

DBMS_XMLDOM.MAKENODE(
   df       IN     DOMDocumentFragment)
 RETURN DOMNode;

Casts the given DOMDocumentType to a DOMNode, and returns that DOMNode (See Also: DOMDocumentType Subprograms):

DBMS_XMLDOM.MAKENODE(
   dt       IN     DOMDocumentType)
 RETURN DOMNode;

Casts the given DOMElement to a DOMNode, and returns that DOMNode (See Also: DOMElement Subprograms):

DBMS_XMLDOM.MAKENODE(
   elem       IN     DOMElement)
 RETURN DOMNode;

Casts given DOMEntity to a DOMNode, and returns that DOMNode (See Also: DOMEntity Subprograms):

DBMS_XMLDOM.MAKENODE(
   ent       IN     DOMEntity)
 RETURN DOMNode;

Casts the DOMEntityReference to a DOMNode, and returns that DOMNode (See Also: DOMEntityReference Subprograms):

DBMS_XMLDOM.MAKENODE(
   eref       IN     DOMEntityReference)
 RETURN DOMNode;

Casts the DOMNotation to a DOMNode, and returns that DOMNode (See Also: DOMNotation Subprograms):

DBMS_XMLDOM.MAKENODE(
   n       IN     DOMNotation)
 RETURN DOMNode;

Casts the DOMProcessingInstruction to a DOMNode, and returns the DOMNode (See Also: DOMProcessingInstruction Subprograms):

DBMS_XMLDOM.MAKENODE(
   pi       IN     DOMProcessingInstruction)
 RETURN DOMNode;

Casts the DOMText to a DOMNode, and returns that DOMNode (See Also: DOMText Subprograms):

DBMS_XMLDOM.MAKENODE(
   t       IN     DOMText)
 RETURN DOMNode;

Parameters

Table 113-102  MAKENODE Function Parameters

Parameter	Description
a	DOMAttr to cast.
cds	DOMCDataSection to cast.
cd	DOMCharacterData to cast.
com	DOMComment to cast.
doc	DOMDocument to cast.
df	DOMDocumentFragment to cast.
dt	DOMDocumentType to cast.
elem	DOMElement to cast.
ent	DOMEntity to cast.
eref	DOMEntityReference to cast.
n	DOMNotation to cast.
pi	DOMProcessingInstruction to cast.
t	DOMText to cast.

---

MAKENOTATION Function

This function casts a given DOMNode to a DOMNotation, and returns the DOMNotation.

Syntax

DBMS_XMLDOM.MAKENOTATION(
   n       IN     DOMNode)
 RETURN DOMNotation;

Parameters

Table 113-103 MAKENOTATION Function Parameters

Parameter	Description
n	DOMNode to cast

---

MAKEPROCESSINGINSTRUCTION Function

This function casts a given DOMNode to a DOMProcessingInstruction, and returns the DOMProcessingInstruction.

Syntax

DBMS_XMLDOM.MAKEPROCESSINGINSTRUCTION(
   n       IN     DOMNode)
 RETURN DOMProcessingInstruction;

Parameters

Table 113-104 MAKEPROCESSINGINSTRUCTION Function Parameters

Parameter	Description
n	DOMNode to cast

---

MAKETEXT Function

This function casts a given DOMNode to a DOMText, and returns the DOMText.

Syntax

DBMS_XMLDOM.MAKETEXT(
   n       IN     DOMNode)
 RETURN DOMText;

Parameters

Table 113-105 MAKETEXT Function Parameters

Parameter	Description
n	DOMNode to cast

---

NEWDOMDOCUMENT Functions

Returns a new DOMDocument instance.

Syntax

Returns a new DOMDocument instance:

DBMS_XMLDOM.NEWDOMDOCUMENT
 RETURN DOMDocument;

Returns a new DOMDocument instance created from the specified XMLType object:

DBMS_XMLDOM.NEWDOMDOCUMENT(
   xmldoc    IN sys.XMLType)
 RETURN DOMDocument;

Returns a new DOMDocument instance created from the specified CLOB:

DBMS_XMLDOM.NEWDOMDOCUMENT(
   cl       IN    CLOB)
 RETURN DOMDocument;

Parameters

Table 113-106 NEWDOMDOCUMENT Function Parameters 

Parameter	Description
xmldoc	XMLType source for the DOMDocument.
cl	CLOB source for the DOMDocument.

---

NORMALIZE Procedure

This procedure normalizes the text children of the DOMElement.

Syntax

DBMS_XMLDOM.NORMALIZE(
   elem       IN     DOMElement);

Parameters

Table 113-107 NORMALIZE Procedure Parameters

Parameter	Description
elem	The DOMElement.

---

REMOVEATTRIBUTE Procedures

Removes an attribute from the DOMElement by name.

Syntax

Removes the value of a DOMElement's attribute by name:

DBMS_XMLDOM.REMOVEATTRIBUTE(
   elem     IN    DOMElement,
   name     IN    VARCHAR2);

Removes the value of a DOMElement's attribute by name and namespace URI.

DBMS_XMLDOM.REMOVEATTRIBUTE(
   elem     IN    DOMElement,
   name     IN    VARCHAR2,
   ns       IN    VARCHAR2);

Parameters

Table 113-108 REMOVEATTRIBUTE Procedure Parameters

Parameter	Description
elem	The DOMElement.
name	Attribute name.
ns	Namespace.

---

REMOVEATTRIBUTENODE Function

This function removes the specified attribute node from the DOMElement. The method returns the removed node.

Syntax

DBMS_XMLDOM.REMOVEATTRIBUTENODE(
   elem       IN     DOMElement,
   oldAttr    IN     DOMAttr)
  RETURN DOMAttr;

Parameters

Table 113-109 REMOVEATTRIBUTENODE Function Parameters

Parameter	Description
elem	The DOMElement.
oldAttr	The old DOMAttr.

---

REMOVECHILD Function

This function removes the child node indicated by OLDChild from the list of children, and returns it.

Syntax

DBMS_XMLDOM.REMOVECHILD(
   n          IN     DOMNode,
   oldChild   IN     DOMNode)
 RETURN DOMNode;

Parameters

Table 113-110 REMOVECHILD Function Parameters

Parameter	Description
n	DOMNode.
oldCHild	The child of the node n to be removed.

---

REMOVENAMEDITEM Function

This function removes from the map a node specified by name; returns this node. When this map contains the attributes attached to an element, if the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.

Syntax

Removes a node specified by name:

DBMS_XMLDOM.REMOVENAMEDITEM(
   nnm      IN     DOMNamedNodeMap,
   name     IN     VARCHAR2)
 RETURN DOMNode;

Removes a node specified by name and namespace URI:

DBMS_XMLDOM.REMOVENAMEDITEM(
   nnm      IN     DOMNamedNodeMap,
   name     IN     VARCHAR2,
   ns       IN     VARCHAR2)
 RETURN DOMNode;

Parameters

Table 113-111 REMOVENAMEDITEM Function Parameters

Parameter	Description
nnm	DOMNamedNodeMap
name	The name of the item to be removed from the map
ns	Namespace

---

REPLACECHILD Function

This function 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.

Syntax

DBMS_XMLDOM.REPLACECHILD(
   n           IN     DOMNode,
   newChild    IN     DOMNode,
   oldChild    IN     DOMNode)
 RETURN DOMNode;

Parameters

Table 113-112 REPLACECHILD Function Parameters

Parameter	Description
n	DOMNode.
newChild	The new child which is to replace the old child.
oldChild	The child of the node n which is to be replaced.

---

REPLACEDATA Procedure

This procedure changes a range of characters in the node. Upon success, data and length reflect the change.

Syntax

DBMS_XMLDOM.REPLACEDATA(
   cd        IN     DOMCharacterData,
   offset    IN     NUMBER,
   cnt       IN     NUMBER,
   arg       IN     VARCHAR2);

Parameters

Table 113-113 REPLACEDATA Procedure Parameters

Parameter	Description
cd	DOMCharacterData.
offset	The offset at which to replace.
cnt	The number of characters to replace.
arg	The value to replace with.

---

RESOLVENAMESPACEPREFIX Function

This function resolves the given namespace prefix, and returns the resolved namespace.

Syntax

DBMS_XMLDOM.RESOLVENAMESPACEPREFIX(
   elem       IN     DOMElement,
   prefix     IN     VARCHAR2) 
 RETURN VARCHAR2;

Parameters

Table 113-114 RESOLVENAMESPACEPREFIX Function Parameters

Parameter	Description
elem	The DOMElement.
prefix	Namespace prefix.

---

SETATTRIBUTE Procedures

Sets the value of a DOMElement's attribute by name.

Syntax

Sets the value of a DOMElement's attribute by name:

DBMS_XMLDOM.SETATTRIBUTE(
   elem DOMElement,
   name IN VARCHAR2,
   value IN VARCHAR2);

Sets the value of a DOMElement's attribute by name and namespace URI:

DBMS_XMLDOM.SETATTRIBUTE(
   elem DOMElement,
   name IN VARCHAR2,
   value IN VARCHAR2,
   ns IN VARCHAR2);

Parameters

Table 113-115 SETATTRIBUTE Function Parameters

Parameter	Description
elem	The DOMElement.
name	Attribute name.
value	Attribute value.
ns	Namespace.

---

SETATTRIBUTENODE Functions

Adds a new attribute node to the DOMElement.

Syntax

Adds a new attribute node to the DOMElement:

DBMS_XMLDOM.SETATTRIBUTENODE(
   elem DOMElement,
   newAttr IN DOMAttr)
 RETURN DOMAttr;

Adds a new attribute node to the DOMElement; namespace enabled:

DBMS_XMLDOM.SETATTRIBUTENODE(
   elem DOMElement,
   newAttr IN DOMAttr,
   ns IN VARCHAR2)
 RETURN DOMAttr;

Parameters

Table 113-116 SETATTRIBUTENODE Function Parameters

Parameter	Description
elem	The DOMElement.
newAttr	The new DOMAttr.
ns	The namespace.

---

SETDATA Procedures

This procedure is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Sets the character data of the node that implements this interface (See Also: DOMCharacterData Subprograms):

DBMS_XMLDOM.SETDATA(
   cd       IN     DOMCharacterData,
   data     IN     VARCHAR2);

Sets the content data of the DOMProcessingInstruction (See Also: DOMProcessingInstruction Subprograms):

DBMS_XMLDOM.SETDATA(
   pi       IN     DOMProcessingInstruction,
   data     IN     VARCHAR2);

Parameters

Table 113-117 SETDATA Procedure Parameters

Parameter	Description
cd	DOMCharacterData.
data	The data to which the node is set.
pi	DOMProcessingInstruction.
data	New processing instruction content data.

---

SETNAMEDITEM Function

This function adds a node using its NodeName attribute. If a node with that name is already present in this map, it is replaced by the new one. The old node is returned on replacement; if no replacement is made, NULL is returned.

As the NodeName attribute is used to derive the name under which the node must be stored, multiple nodes of certain types, those that have a "special" string value, cannot be stored because the names would clash. This is seen as preferable to allowing nodes to be aliased.

Syntax

Adds a node using its NodeName attribute:

DBMS_XMLDOM.SETNAMEDITEM(
   nnm     IN     DOMNamedNodeMap,
   arg     IN     DOMNode)
 RETURN DOMNode;

Adds a node using its NodeName attribute and namespace URI:

DBMS_XMLDOM.SETNAMEDITEM(
   nnm     IN     DOMNamedNodeMap,
   arg      IN    DOMNode,
   ns      IN     VARCHAR2)
 RETURN DOMNode;

Parameters

Table 113-118 SETNAMEDITEM Function Parameters

Parameter	Description
nnm	DOMNamedNodeMap.
arg	The Node to be added using its NodeName attribute.
ns	Namespace.

---

SETNODEVALUE Procedure

This procedure sets the value of this node, depending on its type. When it is defined to be NULL, setting it has no effect.

Syntax

DBMS_XMLDOM.SETNODEVALUE(
   n         IN     DOMNode,
   nodeValue IN     VARCHAR2);

Parameters

Table 113-119 SETNODEVALUE Procedure Parameters

Parameter	Description
n	DOMNode.
nodeValue	The value to which node is set.

---

SETPREFIX Procedure

This procedure sets the namespace prefix for this node to the given value.

Syntax

DBMS_XMLDOM.SETPREFIX(
   n       IN     DOMNode,
   prefix  IN     VARCHAR2);

Parameters

Table 113-120 SETPREFIX Procedure Parameters

Parameter	Description
n	DOMNode.
prefix	The value for the namespace prefix of the node.

---

SETSTANDALONE Procedure

This procedure sets the standalone property of the DOMDocument.

Syntax

DBMS_XMLDOM.SETSTANDALONE(
   doc         IN     DOMDocument,
   newvalue    IN     VARCHAR2);

Parameters

Table 113-121 SETSTANDALONE Procedure Parameters

Parameter	Description
doc	DOMDocument.
newvalue	Value of the standalone property of the document.

---

SETVALUE Procedure

This procedure sets the value of the attribute.

Syntax

DBMS_XMLDOM.SETVALUE(
   a       IN     DOMAttr,
   value   IN     VARCHAR2);

Parameters

Table 113-122 SETVALUE Procedure Parameters

Parameter	Description
a	DOMAttr.
value	The value to set the attribute to.

---

SETVERSION Procedure

This procedure sets the version of the DOMDocument.

Syntax

DBMS_XMLDOM.SETVERSION(
   doc        IN     DOMDocument,
   version    IN     VARCHAR2);

Parameters

Table 113-123 SETVERSION Procedure Parameters

Parameter	Description
doc	DOMDocument.
version	The version of the document.

---

SPLITTEXT Function

This function breaks this DOMText node into two DOMText nodes at the specified offset.

Syntax

DBMS_XMLDOM.SPLITTEXT(
   t        IN     DOMText,
   offset   IN     NUMBER)
 RETURN DOMText;

Parameters

Table 113-124 SPLITTEXT Function Parameters

Parameter	Description
t	DOMText.
offset	Offset at which to split.

---

SUBSTRINGDATA Function

This function extracts a range of data from the node.

Syntax

DBMS_XMLDOM.SUBSTRINGDATA(
   cd        IN     DOMCharacterData,
   offset    IN     NUMBER,
   cnt       IN     NUMBER)
 RETURN VARCHAR2;

Parameters

Table 113-125 SUBSTRINGDATA Function Parameters

Parameter	Description
cd	DOMCharacterData.
offset	The starting offset of the data from which to get the data.
cnt	The number of characters (from the offset) of the data to get.

---

WRITETOBUFFER Procedures

This procedure is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Writes XML node to specified buffer using the database character set (See Also: DOMNode Subprograms):

DBMS_XMLDOM.WRITETOBUFFER( 
   n        IN      DOMNode, 
   buffer   IN OUT  VARCHAR2);

Writes XML document to a specified buffer using database character set (See Also: DOMDocument Subprograms):

DBMS_XMLDOM.WRITETOBUFFER( 
   doc       IN      DOMdocument, 
   buffer    IN OUT  VARCHAR2);

Writes the contents of the specified document fragment into a buffer using the database character set (See Also: DOMDocumentFragment Subprograms):

DBMS_XMLDOM.WRITETOBUFFER(
   df        IN      DOMDocumentFragment,
   buffer    IN OUT  VARCHAR2);

Parameters

Table 113-126 WRITETOBUFFER Procedure Parameters

Parameter	Description
n	DOMNode.
buffer	Buffer to write to.
doc	DOMDocument.
df	DOM document fragment.

---

WRITETOCLOB Procedures

This procedure is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Writes XML node to specified CLOB using the database character set (See Also: DOMNode Subprograms):

DBMS_XMLDOM.WRITETOCLOB(
   n       IN      DOMNode, 
   cl      IN OUT  CLOB);

Writes XML document to a specified CLOB using database character set (See Also: DOMDocument Subprograms):

DBMS_XMLDOM.WRITETOCLOB(
   doc     IN      DOMdocument, 
   cl      IN OUT  CLOB);

Parameters

Table 113-127 WRITETOCLOB Procedure Parameters

Parameter	Description
n	DOMNode.
cl	CLOB to write to.
doc	DOMDocument.

---

WRITETOFILE Procedures

This procedure is overloaded. The specific forms of functionality are described alongside the syntax declarations.

Syntax

Writes XML node to specified file using the database character set (See Also: DOMNode Subprograms):

DBMS_XMLDOM.WRITETOFILE(
   n          IN      DOMNode,
   fileName   IN      VARCHAR2);

Writes XML node to specified file using the given character set, which is passed in as a separate parameter (See Also: DOMNode Subprograms):

DBMS_XMLDOM.WRITETOFILE(   n DOMNode,
   fileName   IN      VARCHAR2,
   charset    IN      VARCHAR2);

Writes an XML document to a specified file using database character set (See Also : DOMDocument Subprograms):

DBMS_XMLDOM.WRITETOFILE(
   doc        IN   DOMDocument,

   fileName IN VARCHAR2);

Writes an XML document to a specified file using given character set (See Also : DOMDocument Subprograms):

DBMS_XMLDOM.WRITETOFILE(
   doc       IN   DOMDocument,
   fileName  IN   VARCHAR2,
   charset   IN   VARCHAR2);

Parameters

Table 113-128 WRITETOFILE Procedure Parameters

Parameter	Description
n	DOMNode.
fileName	File to write to.
charset	Given character set.
doc	DOMDocument.
charset	Character set.