171 DBMS_XMLDOM

Syntax

DBMS_XMLDOM.APPENDCHILD(
   n          IN    DOMNode,
   newchild   IN    DOMNode)
 RETURN DOMNODE;

Parameters

Table 171-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.

See Also:

Syntax

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

Parameters

Table 171-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, and serves as a generic copy constructor for nodes. The duplicate node has no parent, its parent node is NULL.

See Also:

Syntax

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

Parameters

Table 171-25 CLONENODE Function Parameters

Parameter	Description
`n`	`DOMNODE`
`deep`	Determines if children are to be cloned

Usage Notes

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.

CREATEATTRIBUTE Functions

This function creates a DOMATTR node.

See Also:

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,
   qname    IN    VARCHAR2,
   ns      IN     VARCHAR2)
RETURN DOMATTR;

Parameters

Table 171-26 CREATEATTRIBUTE Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`
`qname`	New attribute qualified name
`ns`	Namespace

CREATECDATASECTION Function

This function creates a DOMCDATASECTION node.

See Also:

Syntax

DBMS_XMLDOM.CREATECDATASECTION(
   doc     IN      DOMDOCUMENT,
   data    IN      VARCHAR2)
 RETURN DOMCDATASECTION;

Parameters

Table 171-27 CREATECDATASECTION Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`
`data`	Content of the `DOMCDATASECTION` node

CREATECOMMENT Function

This function creates a DOMCOMMENT node.

See Also:

Syntax

DBMS_XMLDOM.CREATECOMMENT(
   doc      IN      DOMDOCUMENT,
   data     IN      VARCHAR2)
 RETURN DOMCOMMENT;

Parameters

Table 171-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.

See Also:

Syntax

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

Parameters

Table 171-29 CREATEDOCUMENT Function Parameters

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

CREATEDOCUMENTFRAGMENT Function

This function creates a DOMDOCUMENTFRAGMENT.

See Also:

Syntax

DBMS_XMLDOM.CREATEDOCUMENTFRAGMENT(
   doc      IN     DOMDOCUMENT)
 RETURN DOMDOCUMENTFRAGMENT;

Parameters

Table 171-30 CREATEDOCUMENTFRAGMENT Function Parameters

Parameter	Description
`doc`	`DOMDocument`

CREATEELEMENT Functions

This function creates a DOMELEMENT.

See Also:

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 171-31 CREATEELEMENT Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`
`tagName`	Tagname for new `DOMELEMENT`
`ns`	Namespace

CREATEENTITYREFERENCE Function

This function creates a DOMENTITYREFERENCE node.

See Also:

Syntax

DBMS_XMLDOM.CREATEENTITYREFERENCE(
   doc        IN     DOMDOCUMENT,
   name       IN     VARCHAR2)
 RETURN DOMENTITYREFERENCE;

Parameters

Table 171-32 CREATEENTITYREFERENCE Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`
`name`	New entity reference name

CREATEPROCESSINGINSTRUCTION Function

This function creates a DOMPROCESSINGINSTRUCTION node.

See Also:

Syntax

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

Parameters

Table 171-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.

See Also:

Syntax

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

Parameters

Table 171-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.

See Also:

Syntax

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

Parameters

Table 171-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 specified DTD, and returns that entity if found.

See Also:

Syntax

DBMS_XMLDOM.FINDENTITY(
   dt     IN     DOMDOCUMENTTYPE,
   name   IN     VARCHAR2,
   par    IN     BOOLEAN) 
 RETURN  DOMENTITY;

Parameters

Table 171-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 specified DTD, and returns it, if found.

See Also:

Syntax

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

Parameters

Table 171-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 171-38 FREEDOCFRAG Procedure Parameters

Parameter	Description
`df`	DOM document fragment

FREEDOCUMENT Procedure

This procedure frees DOMDOCUMENT object.

See Also:

Syntax

DBMS_XMLDOM.FREEDOCUMENT(
   doc     IN     DOMDOCUMENT);

Parameters

Table 171-39 FREEDOCUMENT Procedure Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`

FREEELEMENT Procedure

This procedure frees memory allocated to a DOMElement handle.

See Also:

Syntax

DBMS_XMLDOM.FREENODE(
   elem      IN     DOMELEMENT);

Parameters

Table 171-40 FREENODE Procedure Parameters

Parameter	Description
elem	Of type `DOMELEMENT`

FREENODE Procedure

This procedure frees all resources associated with a DOMNODE.

See Also:

Syntax

DBMS_XMLDOM.FREENODE(
   n      IN     DOMNODE);

Parameters

Table 171-41 FREENODE Procedure Parameters

Parameter	Description
`n`	`DOMNODE`

FREENODELIST Procedure

This procedure frees all resources associated with a nodelist.

See Also:

DOMNodeList Subprograms

Syntax

DBMS_XMLDOM.FREENODE(
   nl    IN    DOMNodeList);

Parameters

Table 171-42 FREENODE Procedure Parameters

Parameter	Description
`n`l	Of type `DOMNODELIST`

GETATTRIBUTE Functions

This function returns the value of an attribute of an DOMELEMENT by name.

See Also:

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 171-43 GETATTRIBUTE Function Parameters

Parameter	Description
`elem`	The `DOMELEMENT`
`name`	Attribute name
`ns`	Namespace

GETATTRIBUTENODE Functions

This function returns an attribute node from the DOMELEMENT by name. The function is overloaded. The specific forms of functionality are described along with the syntax declarations.

See Also:

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 171-44 GETATTRIBUTENODE Function Parameters

Parameter	Description
`elem`	The `DOMELEMENT`
`name`	Attribute name; * matches any attribute
`ns`	Namespace

GETATTRIBUTES Function

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

See Also:

Syntax

DBMS_XMLDOM.GETATTRIBUTES(
   n      IN      DOMNode)
 RETURN DOMNAMEDNODEMAP;

Parameters

Table 171-45 GETATTRIBUTES Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETCHARSET Function

This function retrieves the characterset of the DOM document.

See Also:

Syntax

DBMS_XMLDOM.GETCHARSET(
   doc IN    DOMDocument)
 RETURN VARCHAR2;

Parameters

Table 171-46 GETCHARSET Function Parameters

Parameter	Description
doc	`DOM` document

Usage Notes

For a newly parsed document, we return the database characterset. Once the SETCHARSET Procedure is called with a non-NULL value for charset, that charset is returned.

GETCHILDNODES Function

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

See Also:

Syntax

DBMS_XMLDOM.GETCHILDNODES(
   n      IN    DOMNode)
 RETURN DOMNodeList;

Parameters

Table 171-47 GETCHILDNODES Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETCHILDRENBYTAGNAME Functions

This function returns the children of the DOMELEMENT.

See Also:

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 171-48 GETCHILDRENBYTAGNAME Function Parameters

Parameter	Description
`elem`	`DOMELEMENT`
`name`	Tag name
`ns`	Namespace

GETDATA Functions

This function is overloaded. The specific forms of functionality are described along with 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 171-49 GETDATA Function Parameters

Parameter	Description
`cd`	`DOMCHARACTERDATA`
`pi`	The `DOMPROCESSINGINSTRUCTION`

GETDOCTYPE Function

This function returns the DTD associated to the DOMDOCUMENT.

See Also:

Syntax

DBMS_XMLDOM.GETDOCTYPE(
   doc      IN     DOMDOCUMENT)
RETURN DOMDOCUMENTTYPE;

Parameters

Table 171-50 GETDOCTYPE Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`

GETDOCUMENTELEMENT Function

This function returns the root element of the DOMDOCUMENT.

See Also:

Syntax

DBMS_XMLDOM.GETDOCUMENTELEMENT(
   doc      IN      DOMDOCUMENT)
 RETURN DOMELEMENT;

Parameters

Table 171-51 GETDOCUMENTELEMENT Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`

GETELEMENTSBYTAGNAME Functions

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

Syntax

Returns a DOMNODELIST of all the elements with a specified 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 171-52 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 DOMNAMEDNODEMAP containing the general entities, both external and internal, declared in the DTD.

See Also:

Syntax

DBMS_XMLDOM.GETENTITIES(
   dt      IN     DOMDocumentType)
 RETURN DOMNAMEDNODEMAP;

Parameters

Table 171-53 GETENTITIES Function Parameters

Parameter	Description
`dt`	`DOMDOCUMENTTYPE`

GETEXPANDEDNAME Procedure and Functions

This subprogram is overloaded as a procedure and two functions. The specific forms of functionality are described along with 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 171-54 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.

See Also:

Syntax

DBMS_XMLDOM.GETFIRSTCHILD(
   n      IN      DOMNODE)
 RETURN DOMNODE;

Parameters

Table 171-55 GETFIRSTCHILD Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETIMPLEMENTATION Function

This function returns the DOMIMPLEMENTATION object that handles this DOMDOCUMENT.

See Also:

Syntax

DBMS_XMLDOM.GETIMPLEMENTATION(
   doc      IN     DOMDOCUMENT)
 RETURN DOMIMPLEMENTATION;

Parameters

Table 171-56 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.

See Also:

DOMNamedNodeMap Subprograms

Syntax

DBMS_XMLDOM.GETLASTCHILD(
   n     IN   DOMNODE)
 RETURN DOMNODE;

Parameters

Table 171-57 GETLASTCHILD Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETLENGTH Functions

This function is overloaded. The specific forms of functionality are described along with 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 171-58 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 171-59 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 171-60 GETNAME Function Parameters

Parameter	Description
`a`	`DOMATTR`
`dt`	`DOMDOCUMENTTYPE`

GETNAMEDITEM Function

This function retrieves a node specified by name.

See Also:

Syntax

Retrieves a node specified by name:

DBMS_XMLDOM.GETNAMEDITEM(
   nnm    IN  DOMNAMEDNODEMAP,
   name   IN  VARCHAR2)
 RETURN DOMNODE;

Retrieves a node specified by name and namespace URI:

DBMS_XMLDOM.GETNAMEDITEM(
   nnm    IN  DOMNAMEDNODEMAP,
   name   IN  VARCHAR2,
   ns     IN  VARCHAR2)
 RETURN DOMNODE;

Parameters

Table 171-61 GETNAMEDITEM Function Parameters

Parameter	Description
`nnm`	`DOMNAMEDNODEMAP`
`name`	Name of the item to be retrieved
`ns`	Namespace

GETNAMESPACE Procedure and Functions

This subprogram 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 171-62 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.

See Also:

Syntax

DBMS_XMLDOM.GETNEXTSIBLING(
   n       IN     DOMNODE)
 RETURN DOMNode;

Parameters

Table 171-63 GETNEXTSIBLING Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETNODETYPE Function

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

See Also:

Syntax

DBMS_XMLDOM.GETNODETYPE(
   n       IN     DOMNODE)
 RETURN NUMBER;

Parameters

Table 171-64 GETNODETYPE Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETNODENAME Function

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

See Also:

Syntax

DBMS_XMLDOM.GETNODENAME(
   n       IN     DOMNODE)
 RETURN VARCHAR2;

Parameters

Table 171-65 GETNODENAME Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETNODEVALUE Function

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

See Also:

Syntax

DBMS_XMLDOM.GETNODEVALUE(
   n       IN     DOMNODE)
 RETURN VARCHAR2;*

Parameters

Table 171-66 GETNODEVALUE Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETNODEVALUEASBINARYSTREAM Function & Procedure

The operation of these subprograms is described with each syntax implementation.

See Also:

Syntax

This function returns an instance of the PL/SQL XMLBinaryInputStream. The node data type must be RAW or BLOB – if not an exception is raised.

DBMS_XMLDOM.GETNODEVALUEASBINARYSTREAM (
   n      IN     DOMNODE)
 RETURN SYS.UTL_BINARYINPUTSTREAM;

Using this procedure, the application passes an implementation of SYS.UTL_BINARYOUTPUTSTREAM into which XDB writes the contents of the node. The data type of the node must be RAW or CLOB – if not an exception is raised.

DBMS_XMLDOM.GETNODEVALUEASBINARYSTREAM (
   n        in   DOMNODE, 
   value    in   SYS.UTL_BINARYOUTPUTSTREAM);

Parameters

Table 171-67 GETNODEVALUEASBINARYSTREAM Function & Procedure Parameters

Parameter	Description
`n`	`DOMNODE`
value	`BINARYOUTPUTSTREAM`

GETNODEVALUEASCHARACTERSTREAM Function & Procedure

The operation of these subprograms is described with each syntax implementation.

See Also:

Syntax

This function returns an instance of the PL/SQL XMLCharacterInputStream. If the node data is character it is converted to the current session character set. If the node data is not character data, it is first converted to character data.

DBMS_XMLDOM.GETNODEVALUEASCHARACTERSTREAM  (
   n        IN     DOMNODE)
 RETURN SYS.UTL_CHARACTERINPUTSTREAM;

Using this procedure, the node data is converted, as necessary, to the session character set and then "pushed" into the SYS.UTL_CHARACTEROUTPUTSTREAM.

DBMS_XMLDOM.GETNODEVALUEASCHARACTERSTREAM  (
   n        IN   DOMNODE,
   value    IN   SYS.UTL_CHARACTEROUTPUTSTREAM);

Parameters

Table 171-68 GETNODEVALUEASCHARACTERSTREAM Function & Procedure Parameters

Parameter	Description
`n`	`DOMNODE`
value	`CHARACTEROUTPUTSTREAM`

GETNOTATIONNAME Function

This function returns the notation name of the DOMENTITY.

See Also:

DOMEntity Subprograms

Syntax

DBMS_XMLDOM.GETNOTATIONNAME(
   ent       IN     DOMENTITY)
 RETURN VARCHAR2;

Parameters

Table 171-69 GETNOTATIONNAME Function Parameters

Parameter	Description
`ent`	`DOMENTITY`

GETNOTATIONS Function

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

See Also:

DOMProcessingInstruction Subprograms

Syntax

DBMS_XMLDOM.GETNOTATIONS(
   dt       IN     DOMDOCUMENTTYPE)
 RETURN DOMNAMEDNODEMAP;

Parameters

Table 171-70 GETNOTATIONS Function Parameters

Parameter	Description
`dt`	`DOMDOCUMENTTYPE`

GETTARGET Function

This function returns the target of the DOMPROCESSINGINSTRUCTION.

See Also:

Syntax

DBMS_XMLDOM.GETTARGET(
   pi       IN     DOMPROCESSINGINSTRUCTION)
 RETURN VARCHAR2;

Parameters

Table 171-71 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.

See Also:

Syntax

DBMS_XMLDOM.GETOWNERDOCUMENT(
   n       IN     DOMNODE)
 RETURN DOMDOCUMENT;

Parameters

Table 171-72 GETOWNERDOCUMENT Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETOWNERELEMENT Function

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

See Also:

Syntax

DBMS_XMLDOM.GETOWNERELEMENT(
   a       IN     DOMATTR)
 RETURN DOMElement;

Parameters

Table 171-73 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.

See Also:

Syntax

DBMS_XMLDOM.GETPARENTNODE(
   n       IN     DOMNODE)
 RETURN DOMNODE;

Parameters

Table 171-74 GETPARENTNODE Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETPREFIX Function

This function retrieves the namespace prefix of the node.

See Also:

Syntax

DBMS_XMLDOM.GETPREFIX(
   n       IN     DOMNODE)
 RETURN VARCHAR2;

Parameters

Table 171-75 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.

See Also:

Syntax

DBMS_XMLDOM.GETPREVIOUSSIBLING(
   n       IN     DOMNODE)
 RETURN DOMNODE;

Parameters

Table 171-76 GETPREVIOUSSIBLING Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETPUBLICID Functions

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

Syntax

Returns the public identifier of the specified 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 171-77 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 along with 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 171-78 GETQUALIFIEDNAME Functions Parameters

Parameter	Description
`a`	`DOMATTR`
`elem`	`DOMELEMENT`

GETSCHEMANODE Function

This function retrieves the schema URI associated with the node.

See Also:

Syntax

DBMS_XMLDOM.GETSCHEMANODE(
   n       IN     DOMNODE)
 RETURN DOMNODE;

Parameters

Table 171-79 GETSCHEMANODE Function Parameters

Parameter	Description
`n`	`DOMNODE`

GETSPECIFIED Function

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

See Also:

Syntax

DBMS_XMLDOM.GETSPECIFIED(
   a       IN     DOMATTR)
 RETURN BOOLEAN;

Parameters

Table 171-80 GETSPECIFIED Function Parameters

Parameter	Description
`a`	`DOMATTR`

GETSTANDALONE Function

This function returns the standalone property associated with the DOMDOCUMENT.

See Also:

Syntax

DBMS_XMLDOM.GETSTANDALONE(
   doc       IN     DOMDOCUMENT)
 RETURN VARCHAR2;

Parameters

Table 171-81 GETSTANDALONE Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`.

GETSYSTEMID Functions

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

Syntax

Returns the system id of the specified 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 171-82 GETSYSTEMID Function Parameters

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

GETTAGNAME Function

This function returns the name of the DOMELEMENT.

See Also:

Syntax

DBMS_XMLDOM.GETTAGNAME(
   elem       IN     DOMELEMENT)
 RETURN VARCHAR2;

Parameters

Table 171-83 GETTAGNAME Function Parameters

Parameter	Description
`elem`	The `DOMELEMENT`

GETVALUE Function

This function retrieves the value of the attribute.

See Also:

Syntax

DBMS_XMLDOM.GETVALUE(
   a       IN     DOMATTR)
 RETURN VARCHAR2;

Parameters

Table 171-84 GETVALUE Function Parameters

Parameter	Description
`a`	`DOMATTR`

GETVERSION Function

This function returns the version of the DOMDOCUMENT.

See Also:

Syntax

DBMS_XMLDOM.GETVERSION(
   doc       IN     DOMDOCUMENT)
 RETURN VARCHAR2;

Parameters

Table 171-85 GETVERSION Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`

GETXMLTYPE Function

This function returns the XMLType associated with the DOMDOCUMENT.

See Also:

Syntax

DBMS_XMLDOM.GETXMLTYPE(
   doc       IN     DOMDOCUMENT)
 RETURN SYS.XMLTYPE;

Parameters

Table 171-86 GETXMLTYPE Function Parameters

Parameter	Description
`doc`	`DOMDOCUMENT`

HASATTRIBUTE Functions

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

See Also:

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 171-87 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.

See Also:

Syntax

DBMS_XMLDOM.HASATTRIBUTES(
   n       IN     DOMNODE)
 RETURN BOOLEAN;

Parameters

Table 171-88 HASATTRIBUTES Function Parameters

Parameter	Description
`n`	`DOMNODE`

HASCHILDNODES Function

This function determines whether this node has any children.

See Also:

DOMImplementation Subprograms

Syntax

DBMS_XMLDOM.HASCHILDNODES(
   n       IN     DOMNODE)
 RETURN BOOLEAN;

Parameters

Table 171-89 HASCHILDNODES Function Parameters

Parameter	Description
`n`	`DOMNODE`

HASFEATURE Function

This function tests if the DOMIMPLEMENTATION implements a specific feature.

See Also:

Syntax

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

Parameters

Table 171-90 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.

See Also:

Syntax

DBMS_XMLDOM.IMPORTNODE(
   doc            IN  DOMDOCUMENT,
   importedNode   IN  DOMNODE,
   deep           IN  BOOLEAN)
  RETURN DOMNODE;

Parameters

Table 171-91 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.

Usage Notes

Note that the ADOPTNODE Function removes the node from the source document while the IMPORTNODE Function clones the node in the source document.

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.

See Also:

Syntax

DBMS_XMLDOM.INSERTBEFORE(
   n          IN     DOMNODE,
   newchild   IN     DOMNODE,
   refchild   IN     DOMNODE)
  RETURN DOMNode;

Parameters

Table 171-92 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.

See Also:

Syntax

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

Parameters

Table 171-93 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 along with the syntax declarations.

Syntax

Checks if the specified 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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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 specified DOMIMPLEMENTATION is NULL; returns TRUE if it is NULL (See Also: DOMImplementation Subprograms):

DBMS_XMLDOM.ISNULL(
   di       IN     DOMIMPLEMENTATION)
 RETURN BOOLEAN;

Checks that the specified 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 specified 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 specified 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 specified DOMPROCESSINGINSTRUCTION is NULL; returns TRUE if it is NULL, FALSE otherwise (See Also: DOMProcessingInstruction Subprograms):

DBMS_XMLDOM.ISNULL(
   pi       IN     DOMPROCESSINGINSTRUCTION)
 RETURN BOOLEAN;

Checks that the specified 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 171-94 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

ITEM Functions

This function is overloaded. The specific forms of functionality are described along with 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 171-95 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 specified DOMNODE to a DOMATTR, and returns the DOMATTR.

See Also:

Syntax

DBMS_XMLDOM.MAKEATTR(
   n       IN     DOMNODE)
 RETURN DOMATTR;

Parameters

Table 171-96 MAKEATTR Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKECDATASECTION Function

This function casts a specified DOMNODE to a DOMCDATASECTION.

See Also:

Syntax

DBMS_XMLDOM.MAKECDATASECTION(
   n       IN     DOMNODE)
 RETURN DOMCDATASECTION;

Parameters

Table 171-97 MAKECDATASECTION Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKECHARACTERDATA Function

This function casts a specified DOMNODE to a DOMCHARACTERDATA, and returns the DOMCHARACTERDATA.

See Also:

Syntax

DBMS_XMLDOM.MAKECHARACTERDATA(
   n       IN     DOMNode)
 RETURN DOMCharacterData;

Parameters

Table 171-98 MAKECHARACTERDATA Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKECOMMENT Function

This function casts a specified DOMNODE to a DOMCOMMENT, and returns the DOMCOMMENT.

See Also:

Syntax

DBMS_XMLDOM.MAKECOMMENT(
   n       IN     DOMNODE)
 RETURN DOMCOMMENT;

Parameters

Table 171-99 MAKECOMMENT Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKEDOCUMENT Function

This function casts a specified DOMNODE to a DOMDOCUMENT, and returns the DOMDOCUMENT.

See Also:

Syntax

DBMS_XMLDOM.MAKEDOCUMENT(
   n       IN     DOMNODE)
 RETURN DOMDocument;

Parameters

Table 171-100 MAKEDOCUMENT Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKEDOCUMENTFRAGMENT Function

This function casts a specified DOMNODE to a DOMDOCUMENTFRAGMENT, and returns the DOMDOCUMENTFRAGMENT.

See Also:

Syntax

DBMS_XMLDOM.MAKEDOCUMENTFRAGMENT(
   n       IN     DOMNODE)
 RETURN DOMDOCUMENTFRAGMENT;

Parameters

Table 171-101 MAKEDOCUMENTFRAGMENT Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKEDOCUMENTTYPE Function

This function casts a specified DOMNODE to a DOMDOCUMENTTYPE and returns the DOMDOCUMENTTYPE.

See Also:

Syntax

DBMS_XMLDOM.MAKEDOCUMENTTYPE(
   n       IN     DOMNODE)
 RETURN DOMDOCUMENTTYPE;

Parameters

Table 171-102 MAKEDOCUMENTTYPE Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast.

MAKEELEMENT Function

This function casts a specified DOMNODE to a DOMELEMENT, and returns the DOMELEMENT.

See Also:

Syntax

DBMS_XMLDOM.MAKEELEMENT(
   n       IN     DOMNODE)
 RETURN DOMELEMENT;

Parameters

Table 171-103 MAKEELEMENT Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKEENTITY Function

This function casts a specified DOMNODE to a DOMENTITY, and returns the DOMENTITY.

See Also:

Syntax

DBMS_XMLDOM.MAKEENTITY(
   n       IN     DOMNODE)
 RETURN DOMENTITY;

Parameters

Table 171-104 MAKEENTITY Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKEENTITYREFERENCE Function

This function casts a specified DOMNODE to a DOMENTITYREFERENCE, and returns the DOMENTITYREFERENCE.

See Also:

Syntax

DBMS_XMLDOM.MAKEENTITYREFERENCE(
   n       IN     DOMNODE)
 RETURN DOMENTITYREFERENCE;

Parameters

Table 171-105 MAKEENTITYREFERENCE Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKENODE Functions

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

Syntax

Casts specified 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 specified DOMCHARACTERDATA as a DOMNODE, and returns that DOMNODE (See Also: DOMCharacterData Subprograms):

DBMS_XMLDOM.MAKENODE(
   cd       IN     DOMCHARACTERDATA)
 RETURN DOMNODE;

Casts the specified 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 specified DOMDOCUMENTFRAGMENT to a DOMNODE, and returns that DOMNODE (See Also: DOMDocumentFragment Subprograms):

DBMS_XMLDOM.MAKENODE(
   df       IN     DOMDOCUMENTFRAGMENT)
 RETURN DOMNode;

Casts the specified DOMDOCUMENTTYPE to a DOMNODE, and returns that DOMNODE (See Also: DOMDocumentType Subprograms):

DBMS_XMLDOM.MAKENODE(
   dt       IN     DOMDOCUMENTTYPE)
 RETURN DOMNODE;

Casts the specified DOMELEMENT to a DOMNODE, and returns that DOMNODE (See Also: DOMElement Subprograms):

DBMS_XMLDOM.MAKENODE(
   elem       IN     DOMELEMENT)
 RETURN DOMNODE;

Casts specified 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 171-106 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 specified DOMNODE to a DOMNOTATION, and returns the DOMNOTATION.

See Also:

Syntax

DBMS_XMLDOM.MAKENOTATION(
   n       IN     DOMNODE)
 RETURN DOMNOTATION;

Parameters

Table 171-107 MAKENOTATION Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKEPROCESSINGINSTRUCTION Function

This function casts a specified DOMNODE to a DOMPROCESSINGINSTRUCTION, and returns the Domprocessinginstruction.

See Also:

Syntax

DBMS_XMLDOM.MAKEPROCESSINGINSTRUCTION(
   n       IN     DOMNODE)
 RETURN DOMPROCESSINGINSTRUCTION;

Parameters

Table 171-108 MAKEPROCESSINGINSTRUCTION Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

MAKETEXT Function

This function casts a specified DOMNODE to a DOMTEXT, and returns the DOMTEXT.

See Also:

Syntax

DBMS_XMLDOM.MAKETEXT(
   n       IN     DOMNODE)
 RETURN DOMTEXT;

Parameters

Table 171-109 MAKETEXT Function Parameters

Parameter	Description
`n`	`DOMNODE` to cast

NEWDOMDOCUMENT Functions

This function returns a new DOMDOCUMENT instance.

See Also:

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 171-110 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.

See Also:

Syntax

DBMS_XMLDOM.NORMALIZE(
   elem       IN     DOMELEMENT);

Parameters

Table 171-111 NORMALIZE Procedure Parameters

Parameter	Description
`elem`	The `DOMELEMENT`

REMOVEATTRIBUTE Procedures

This procedure removes an attribute from the DOMELEMENT by name.

See Also:

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 171-112 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.

See Also:

Syntax

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

Parameters

Table 171-113 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.

See Also:

DOMNamedNodeMap Subprograms

Syntax

DBMS_XMLDOM.REMOVECHILD(
   n          IN     DOMNode,
   oldchild   IN     DOMNode)
 RETURN DOMNODE;

Parameters

Table 171-114 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, and 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.

See Also:

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 171-115 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.

See Also:

Syntax

DBMS_XMLDOM.REPLACECHILD(
   n           IN     DOMNode,
   newchild    IN     DOMNode,
   oldchild    IN     DOMNode)
 RETURN DOMNode;

Parameters

Table 171-116 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.

See Also:

Syntax

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

Parameters

Table 171-117 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 specified namespace prefix, and returns the resolved namespace.

See Also:

Syntax

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

Parameters

Table 171-118 RESOLVENAMESPACEPREFIX Function Parameters

Parameter	Description
`elem`	The `DOMELEMENT`
`prefix`	Namespace prefix

SETATTRIBUTE Procedures

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

See Also:

Syntax

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

DBMS_XMLDOM.SETATTRIBUTE(
   elem       IN  DOMELEMENT,
   name       IN  VARCHAR2,
   newvalue   IN  VARCHAR2);

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

DBMS_XMLDOM.SETATTRIBUTE(
   elem       IN  DOMELEMENT,
   name       IN  VARCHAR2,
   newvalue   IN  VARCHAR2,
   ns         IN  VARCHAR2);

Parameters

Table 171-119 SETATTRIBUTE Procedure Parameters

Parameter	Description
`elem`	The `DOMELEMENT`
`name`	Attribute name
`newvalue`	Attribute value
`ns`	Namespace

SETATTRIBUTENODE Functions

Adds a new attribute node to the DOMELEMENT.

See Also:

Syntax

Adds a new attribute node to the DOMELEMENT:

DBMS_XMLDOM.SETATTRIBUTENODE(
   elem      IN  DOMELEMENT,
   newAttr   IN  DOMATTR)
 RETURN DOMATTR;

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

DBMS_XMLDOM.SETATTRIBUTENODE(
   elem      IN  DOMELEMENT,
   newAttr   IN  DOMATTR,
   ns        IN  VARCHAR2)
 RETURN DOMATTR;

Parameters

Table 171-120 SETATTRIBUTENODE Function Parameters

Parameter	Description
`elem`	The `DOMELEMENT`
`newAttr`	The new `DOMATTR`
`ns`	The namespace

SETCHARSET Procedure

This function sets the characterset of the DOM document.

See Also:

DOMNamedNodeMap Subprograms

Syntax

DBMS_XMLDOM.SETCHARSET(
   doc      IN    DOMDocument,
   charset  IN    VARCHAR2);

Parameters

Table 171-121 SETCHARSET Procedure Parameters

Parameter	Description
doc	`DOM` document
charset	Characterset

Usage Notes

This is used for WRITETOFILE Procedures if not explicitly specified at that time.

SETDATA Procedures

This procedure is overloaded. The specific forms of functionality are described along with 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 171-122 SETDATA Procedure Parameters

Parameter	Description
`cd`	`DOMCHARACTERDATA`
`data`	The data to which the node is set
`pi`	`DOMPROCESSINGINSTRUCTION`
`data`	New processing instruction content data

SETDOCTYPE Procedure

Given a DOM document, this procedure creates a new DTD with the specified name, system id and public id and sets it in the document. This DTD can later be retrieved using the GETDOCTYPE Function.

Syntax

DBMS_XMLDOM.SETDOCTYPE(
  doc     IN   DOMDocument, 
  name    IN   VARCHAR2,
  sysid   IN   VARCHAR2, 
  pubid   IN   VARCHAR2);

Parameters

Table 171-123 SETDOCTYPE Procedure Parameters

Parameter	Description
`doc`	The document whose DTD has to be set
`name`	The name that the doctype needs to be initialized with
`sysid`	The system ID that the doctype needs to be initialized with
`pubid`	The public ID that the doctype needs to be initialized with

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.

See Also:

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 171-124 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.

See Also:

Syntax

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

Parameters

Table 171-125 SETNODEVALUE Procedure Parameters

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

SETNODEVALUEASBINARYSTREAM Function & Procedure

The operation of these subprograms is described with each syntax implementation.

See Also:

Syntax

This function returns an instance of the PL/SQL XMLBINARYOUTPUTSTREAM into which the caller can write the node value. The data type of the node must be RAW or BLOB – if not, an exception is raised.

DBMS_XMLDOM.SETNODEVALUEASBINARYSTREAM (
   n      IN     DOMNODE)
 RETURN SYS.UTL_BINARYOUTPUTSTREAM;

Using this procedure, the application passes in an implementation of sys.utl_BinaryInputStream from which XDB reads data to populate the node. The data type of the node must be RAW or BLOB – if not an exception is raised.

DBMS_XMLDOM.SETNODEVALUEASBINARYSTREAM (
   n        in   DOMNODE, 
   value    in   SYS.UTL_BINARYINPUTSTREAM);

Parameters

Table 171-126 SETNODEVALUEASBINARYSTREAM Function & Procedure Parameters

Parameter	Description
`n`	`DOMNODE`
value	`BINARYINPUTSTREAM`

SETNODEVALUEASCHARACTERSTREAM Function & Procedure

The operation of these subprograms is described with each syntax implementation.

See Also:

Syntax

This function returns an instance of the PL/SQL XMLCHARACTEROUTPUTSTREAM type into which the caller can write the node value. The data type of the node can be any valid XDB data type. If the type is not character or CLOB, the character data written to the stream is converted to the node data type. If the data type of the node is character or CLOB, then the character data written to the stream is converted from PL/SQL session character set to the character set of the node.

DBMS_XMLDOM.SETNODEVALUEASCHARACTERSTREAM  (
   n        IN     DOMNODE)
 RETURN SYS.UTL_CHARACTEROUTPUTSTREAM;

Using this procedure, the application passes in an implementation of SYS.UTL_CHARACTERINPUTSTREAM from which XDB reads to populate the node. The data type of the node may be any valid type supported by XDB. If a non-character data type, the character data read from the stream is converted to the data type of the node. If the data type of the node is either character or CLOB, then no conversion occurs and the character set of the node becomes the character set of the PL/SQL session.

DBMS_XMLDOM.SETNODEVALUEASCHARACTERSTREAM  (
   n        IN   DOMNODE,
   value    IN   SYS.UTL_CHARACTERINPUTSTREAM);

Parameters

Table 171-127 SETNODEVALUEASCHARACTERSTREAM Function & Procedure Parameters

Parameter	Description
`n`	`DOMNODE`
value	`CHARACTERINPUTSTREAM`

SETPREFIX Procedure

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

See Also:

Syntax

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

Parameters

Table 171-128 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.

See Also:

Syntax

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

Parameters

Table 171-129 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.

See Also:

Syntax

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

Parameters

Table 171-130 SETVALUE Procedure Parameters

Parameter	Description
`a`	`DOMATTR`
`value`	The value to which to set the attribute

SETVERSION Procedure

This procedure sets the version of the DOMDOCUMENT.

See Also:

Syntax

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

Parameters

Table 171-131 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.

See Also:

DOMText Subprograms

Syntax

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

Parameters

Table 171-132 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.

See Also:

Syntax

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

Parameters

Table 171-133 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

USEBINARYSTREAM Function

This function returns TRUE if the data type of the node is RAW or BLOB so that the node value may be read or written using an UTL_BINARYINPUTSTREAM or UTL_BINARYOUTPUTSTREAM. If a value of FALSE is returned, the node value may only be accessed through an UTL_CHARACTERINPUTSTREAM or UTL_CHARACTEROUTPUTSTREAM.

See Also: