All Packages Previous Next 

W3C DOM APIs

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 way a document is accessed and manipulated. In the DOM specification, the term "document" is used in the broad sense - increasingly, XML is being used as a way of representing many different kinds of information that may be stored in diverse systems, and much of this would traditionally be seen as data rather than as documents. Nevertheless, XML presents this data as documents, and the DOM may be used to manage this data.

With the Document Object Model, programmers can build documents, navigate their structure, and add, modify, or delete elements and content. 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 specification for the Document Object Model is to provide a standard programming interface that can be used in a wide variety of environments and applications. The DOM is designed to be used with any programming language. Since the DOM standard is object-oriented, for this PLSQL adaptation, some changes had to be made:

The implementation of this PLSQL DOM interface followed the DOM standard of revision REC-DOM-Level-1-19981001. The types and methods described in this document are made available by the PLSQL package xmldom.


Types

DOM Node types

 o ELEMENT_NODE
 o ATTRIBUTE_NODE
 o TEXT_NODE
 o CDATA_SECTION_NODE
 o ENTITY_REFERENCE_NODE
 o ENTITY_NODE
 o PROCESSING_INSTRUCTION_NODE
 o COMMENT_NODE
 o DOCUMENT_NODE
 o DOCUMENT_TYPE_NODE
 o DOCUMENT_FRAGMENT_NODE
 o NOTATION_NODE

DOMException types

 o INDEX_SIZE_ERR
 o DOMSTRING_SIZE_ERR
 o HIERARCHY_REQUEST_ERR
 o WRONG_DOCUMENT_ERR
 o INVALID_CHARACTER_ERR
 o NO_DATA_ALLOWED_ERR
 o NO_MODIFICATION_ALLOWED_ERR
 o NOT_FOUND_ERR
 o NOT_SUPPORTED_ERR
 o INUSE_ATTRIBUTE_ERR

DOM interface types

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

Methods

Node methods

 o FUNCTION isNull(n DOMNode) RETURN BOOLEAN;
 o FUNCTION makeAttr(n DOMNode) RETURN DOMAttr;
 o FUNCTION makeCDataSection(n DOMNode) RETURN DOMCDataSection;
 o FUNCTION makeCharacterData(n DOMNode) RETURN DOMCharacterData;
 o FUNCTION makeComment(n DOMNode) RETURN DOMComment;
 o FUNCTION makeDocumentFragment(n DOMNode) RETURN DOMDocumentFragment;
 o FUNCTION makeDocumentType(n DOMNode) RETURN DOMDocumentType;
 o FUNCTION makeElement(n DOMNode) RETURN DOMElement;
 o FUNCTION makeEntity(n DOMNode) RETURN DOMEntity;
 o FUNCTION makeEntityReference(n DOMNode) RETURN DOMEntityReference;
 o FUNCTION makeNotation(n DOMNode) RETURN DOMNotation;
 o FUNCTION makeProcessingInstruction(n DOMNode) RETURN DOMProcessingInstruction;
 o FUNCTION makeText(n DOMNode) RETURN DOMText;
 o FUNCTION makeDocument(n DOMNode) RETURN DOMDocument;
 o PROCEDURE writeToFile(n DOMNode, fileName VARCHAR2);
 o PROCEDURE writeToBuffer(n DOMNode, buffer IN OUT VARCHAR2);
 o PROCEDURE writeToClob(n DOMNode, cl IN OUT CLOB);
 o PROCEDURE writeToFile(n DOMNode, fileName VARCHAR2, charset VARCHAR2);
 o PROCEDURE writeToBuffer(n DOMNode, buffer IN OUT VARCHAR2, charset VARCHAR2);
 o PROCEDURE writeToClob(n DOMNode, cl IN OUT CLOB, charset VARCHAR2);
 o FUNCTION getNodeName(n DOMNode) RETURN VARCHAR2;
 o FUNCTION getNodeValue(n DOMNode) RETURN VARCHAR2;
 o PROCEDURE setNodeValue(n DOMNode, nodeValue IN VARCHAR2);
 o FUNCTION getNodeType(n DOMNode) RETURN NUMBER;
 o FUNCTION getParentNode(n DOMNode) RETURN DOMNode;
 o FUNCTION getChildNodes(n DOMNode) RETURN DOMNodeList;
 o FUNCTION getFirstChild(n DOMNode) RETURN DOMNode;
 o FUNCTION getLastChild(n DOMNode) RETURN DOMNode;
 o FUNCTION getPreviousSibling(n DOMNode) RETURN DOMNode;
 o FUNCTION getNextSibling(n DOMNode) RETURN DOMNode;
 o FUNCTION getAttributes(n DOMNode) RETURN DOMNamedNodeMap;
 o FUNCTION getOwnerDocument(n DOMNode) RETURN DOMDocument;
 o FUNCTION insertBefore(n DOMNode, newChild IN DOMNode, refChild IN DOMNode) RETURN DOMNode;
 o FUNCTION replaceChild(n DOMNode, newChild IN DOMNode, oldChild IN DOMNode)> RETURN DOMNode;
 o FUNCTION removeChild(n DOMNode, oldChild IN DOMNode) RETURN DOMNode;
 o FUNCTION appendChild(n DOMNode, newChild IN DOMNode) RETURN DOMNode;
 o FUNCTION hasChildNodes(n DOMNode) RETURN BOOLEAN;
 o FUNCTION cloneNode(n DOMNode, deep boolean) RETURN DOMNode;

NamedNodeMap methods

 o FUNCTION isNull(nnm DOMNamedNodeMap) RETURN BOOLEAN;
 o FUNCTION getNamedItem(nnm DOMNamedNodeMap, name IN VARCHAR2) RETURN DOMNode;
 o FUNCTION setNamedItem(nnm DOMNamedNodeMap, arg IN DOMNode) RETURN DOMNode;
 o FUNCTION removeNamedItem(nnm DOMNamedNodeMap, name IN VARCHAR2) RETURN DOMNode;
 o FUNCTION item(nnm DOMNamedNodeMap, idx IN NUMBER) RETURN DOMNode;
 o FUNCTION getLength(nnm DOMNamedNodeMap) RETURN NUMBER;

NodeList methods

 o FUNCTION isNull(nl DOMNodeList) RETURN BOOLEAN;
 o FUNCTION item(nl DOMNodeList, idx IN NUMBER) RETURN DOMNode;
 o FUNCTION getLength(nl DOMNodeList) RETURN NUMBER;

Attr methods

 o FUNCTION isNull(a DOMAttr) RETURN BOOLEAN;
 o FUNCTION makeNode(a DOMAttr) RETURN DOMNode;
 o FUNCTION getQualifiedName(a DOMAttr) RETURN VARCHAR2;
 o FUNCTION getNamespace(a DOMAttr) RETURN VARCHAR2;
 o FUNCTION getLocalName(a DOMAttr) RETURN VARCHAR2;
 o FUNCTION getExpandedName(a DOMAttr) RETURN VARCHAR2;
 o FUNCTION getName(a DOMAttr) RETURN VARCHAR2;
 o FUNCTION getSpecified(a DOMAttr) RETURN BOOLEAN;
 o FUNCTION getValue(a DOMAttr) RETURN VARCHAR2;
 o PROCEDURE setValue(a DOMAttr, value IN VARCHAR2);

CDataSection methods

 o FUNCTION isNull(cds DOMCDataSection) RETURN BOOLEAN;
 o FUNCTION makeNode(cds DOMCDataSection) RETURN DOMNode;

CharacterData methods

 o FUNCTION isNull(cd DOMCharacterData) RETURN BOOLEAN;
 o FUNCTION makeNode(cd DOMCharacterData) RETURN DOMNode;
 o FUNCTION getData(cd DOMCharacterData) RETURN VARCHAR2;
 o PROCEDURE setData(cd DOMCharacterData, data IN VARCHAR2);
 o FUNCTION getLength(cd DOMCharacterData) RETURN NUMBER;
 o FUNCTION substringData(cd DOMCharacterData, offset IN NUMBER, cnt IN NUMBER) RETURN VARCHAR2;
 o PROCEDURE appendData(cd DOMCharacterData, arg IN VARCHAR2);
 o PROCEDURE insertData(cd DOMCharacterData, offset IN NUMBER, arg IN VARCHAR2);
 o PROCEDURE deleteData(cd DOMCharacterData, offset IN NUMBER, cnt IN NUMBER);
 o PROCEDURE replaceData(cd DOMCharacterData, offset IN NUMBER, cnt IN NUMBER, arg IN VARCHAR2);

Comment methods

 o FUNCTION isNull(com DOMComment) RETURN BOOLEAN;
 o FUNCTION makeNode(com DOMComment) RETURN DOMNode;

DOMImplementation methods

 o FUNCTION isNull(di DOMImplementation) RETURN BOOLEAN;
 o FUNCTION hasFeature(di DOMImplementation, feature IN VARCHAR2, version IN VARCHAR2) RETURN BOOLEAN;

DocumentFragment methods

 o FUNCTION isNull(df DOMDocumentFragment) RETURN BOOLEAN;
 o FUNCTION makeNode(df DOMDocumentFragment) RETURN DOMNode;

DocumentType methods

 o FUNCTION isNull(dt DOMDocumentType) RETURN BOOLEAN;
 o FUNCTION makeNode(dt DOMDocumentType) RETURN DOMNode;
 o FUNCTION findEntity(dt DOMDocumentType, name VARCHAR2, par BOOLEAN) RETURN DOMEntity;
 o FUNCTION findNotation(dt DOMDocumentType, name VARCHAR2) RETURN DOMNotation;
 o FUNCTION getPublicId(dt DOMDocumentType) RETURN VARCHAR2;
 o FUNCTION getSystemId(dt DOMDocumentType) RETURN VARCHAR2;
 o PROCEDURE writeExternalDTDToFile(dt DOMDocumentType, fileName VARCHAR2);
 o PROCEDURE writeExternalDTDToBuffer(dt DOMDocumentType, buffer IN OUT VARCHAR2);
 o PROCEDURE writeExternalDTDToClob(dt DOMDocumentType, cl IN OUT CLOB);
 o PROCEDURE writeExternalDTDToFile(dt DOMDocumentType, fileName VARCHAR2, charset VARCHAR2);
 o PROCEDURE writeExternalDTDToBuffer(dt DOMDocumentType, buffer IN OUT VARCHAR2, charset VARCHAR2);
 o PROCEDURE writeExternalDTDToClob(dt DOMDocumentType, cl IN OUT CLOB, charset VARCHAR2);
 o FUNCTION getName(dt DOMDocumentType) RETURN VARCHAR2;
 o FUNCTION getEntities(dt DOMDocumentType) RETURN DOMNamedNodeMap;
 o FUNCTION getNotations(dt DOMDocumentType) RETURN DOMNamedNodeMap;

Element methods

 o FUNCTION isNull(elem DOMElement) RETURN BOOLEAN;
 o FUNCTION makeNode(elem DOMElement) RETURN DOMNode;
 o FUNCTION getQualifiedName(elem DOMElement) RETURN VARCHAR2;
 o FUNCTION getNamespace(elem DOMElement) RETURN VARCHAR2;
 o FUNCTION getLocalName(elem DOMElement) RETURN VARCHAR2;
 o FUNCTION getExpandedName(elem DOMElement) RETURN VARCHAR2;
 o FUNCTION getChildrenByTagName(elem DOMElement, name IN VARCHAR2) RETURN DOMNodeList;
 o FUNCTION getElementsByTagName(elem DOMElement, name IN VARCHAR2, ns VARCHAR2) RETURN DOMNodeList;
 o FUNCTION getChildrenByTagName(elem DOMElement, name IN VARCHAR2, ns VARCHAR2) RETURN DOMNodeList;
 o FUNCTION resolveNamespacePrefix(elem DOMElement, prefix VARCHAR2) RETURN VARCHAR2;
 o FUNCTION getTagName(elem DOMElement) RETURN VARCHAR2;
 o FUNCTION getAttribute(elem DOMElement, name IN VARCHAR2) RETURN VARCHAR2;
 o PROCEDURE setAttribute(elem DOMElement, name IN VARCHAR2, value IN VARCHAR2);
 o PROCEDURE removeAttribute(elem DOMElement, name IN VARCHAR2);
 o FUNCTION getAttributeNode(elem DOMElement, name IN VARCHAR2) RETURN DOMAttr;
 o FUNCTION setAttributeNode(elem DOMElement, newAttr IN DOMAttr) RETURN DOMAttr;
 o FUNCTION removeAttributeNode(elem DOMElement, oldAttr IN DOMAttr) RETURN DOMAttr;
 o FUNCTION getElementsByTagName(elem DOMElement, name IN VARCHAR2) RETURN DOMNodeList;
 o PROCEDURE normalize(elem DOMElement);

Entity methods

 o FUNCTION isNull(ent DOMEntity) RETURN BOOLEAN;
 o FUNCTION makeNode(ent DOMEntity) RETURN DOMNode;
 o FUNCTION getPublicId(ent DOMEntity) RETURN VARCHAR2;
 o FUNCTION getSystemId(ent DOMEntity) RETURN VARCHAR2;
 o FUNCTION getNotationName(ent DOMEntity) RETURN VARCHAR2;

EntityReference methods

 o FUNCTION isNull(eref DOMEntityReference) RETURN BOOLEAN;
 o FUNCTION makeNode(eref DOMEntityReference) RETURN DOMNode;

Notation methods

 o FUNCTION isNull(n DOMNotation) RETURN BOOLEAN;
 o FUNCTION makeNode(n DOMNotation) RETURN DOMNode;
 o FUNCTION getPublicId(n DOMNotation) RETURN VARCHAR2;
 o FUNCTION getSystemId(n DOMNotation) RETURN VARCHAR2;

ProcessingInstruction methods

 o FUNCTION isNull(pi DOMProcessingInstruction) RETURN BOOLEAN;
 o FUNCTION makeNode(pi DOMProcessingInstruction) RETURN DOMNode;
 o FUNCTION getData(pi DOMProcessingInstruction) RETURN VARCHAR2;
 o FUNCTION getTarget(pi DOMProcessingInstruction) RETURN VARCHAR2;
 o PROCEDURE setData(pi DOMProcessingInstruction, data IN VARCHAR2);

Text methods

 o FUNCTION isNull(t DOMText) RETURN BOOLEAN;
 o FUNCTION makeNode(t DOMText) RETURN DOMNode;
 o FUNCTION splitText(t DOMText, offset IN NUMBER) RETURN DOMText;

Document methods

 o FUNCTION isNull(doc DOMDocument) RETURN BOOLEAN;
 o FUNCTION makeNode(doc DOMDocument) RETURN DOMNode;
 o FUNCTION newDOMDocument RETURN DOMDocument;
 o PROCEDURE freeDocument(doc DOMDocument)
 o FUNCTION getVersion(doc DOMDocument) RETURN VARCHAR2;
 o PROCEDURE setVersion(doc DOMDocument, version VARCHAR2);
 o FUNCTION getCharset(doc DOMDocument) RETURN VARCHAR2;
 o PROCEDURE setCharset(doc DOMDocument, charset VARCHAR2);
 o FUNCTION getStandalone(doc DOMDocument) RETURN VARCHAR2;
 o PROCEDURE setStandalone(doc DOMDocument, value VARCHAR2);
 o PROCEDURE writeToFile(doc DOMDocument, fileName VARCHAR2);
 o PROCEDURE writeToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2);
 o PROCEDURE writeToClob(doc DOMDocument, cl IN OUT CLOB);
 o PROCEDURE writeToFile(doc DOMDocument, fileName VARCHAR2, charset VARCHAR2);
 o PROCEDURE writeToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2, charset VARCHAR2);
 o PROCEDURE writeToClob(doc DOMDocument, cl IN OUT CLOB, charset VARCHAR2);
 o PROCEDURE writeExternalDTDToFile(doc DOMDocument, fileName VARCHAR2);
 o PROCEDURE writeExternalDTDToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2);
 o PROCEDURE writeExternalDTDToClob(doc DOMDocument, cl IN OUT CLOB);
 o PROCEDURE writeExternalDTDToFile(doc DOMDocument, fileName VARCHAR2, charset VARCHAR2);
 o PROCEDURE writeExternalDTDToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2, charset VARCHAR2);
 o PROCEDURE writeExternalDTDToClob(doc DOMDocument, cl IN OUT CLOB, charset VARCHAR2);
 o FUNCTION getDoctype(doc DOMDocument) RETURN DOMDocumentType;
 o FUNCTION getImplementation(doc DOMDocument) RETURN DOMImplementation;
 o FUNCTION getDocumentElement(doc DOMDocument) RETURN DOMElement;
 o FUNCTION createElement(doc DOMDocument, tagName IN VARCHAR2) RETURN DOMElement;
 o FUNCTION createDocumentFragment(doc DOMDocument) RETURN DOMDocumentFragment;
 o FUNCTION createTextNode(doc DOMDocument, data IN VARCHAR2) RETURN DOMText;
 o FUNCTION createComment(doc DOMDocument, data IN VARCHAR2) RETURN DOMComment;
 o FUNCTION createCDATASection(doc DOMDocument, data IN VARCHAR2) RETURN DOMCDATASection;
 o FUNCTION createProcessingInstruction(doc DOMDocument, target IN VARCHAR2, data IN VARCHAR2) RETURN DOMProcessingInstruction;
 o FUNCTION createAttribute(doc DOMDocument, name IN VARCHAR2) RETURN DOMAttr;
 o FUNCTION createEntityReference(doc DOMDocument, name IN VARCHAR2) RETURN DOMEntityReference;
 o FUNCTION getElementsByTagName(doc DOMDocument, tagname IN VARCHAR2) RETURN DOMNodeList;

Types Description

DOM Node types description

 o ELEMENT_NODE CONSTANT NATURAL := 1;
 o ATTRIBUTE_NODE CONSTANT NATURAL := 2;
 o TEXT_NODE CONSTANT NATURAL := 3;
 o CDATA_SECTION_NODE CONSTANT NATURAL := 4;
 o ENTITY_REFERENCE_NODE CONSTANT NATURAL := 5;
 o ENTITY_NODE CONSTANT NATURAL := 6;
 o PROCESSING_INSTRUCTION_NODE CONSTANT NATURAL := 7;
 o COMMENT_NODE CONSTANT NATURAL := 8;
 o DOCUMENT_NODE CONSTANT NATURAL := 9;
 o DOCUMENT_TYPE_NODE CONSTANT NATURAL := 10;
 o DOCUMENT_FRAGMENT_NODE CONSTANT NATURAL := 11;
 o NOTATION_NODE CONSTANT NATURAL := 12;

DOMException types description

 o INDEX_SIZE_ERR EXCEPTION;
 o DOMSTRING_SIZE_ERR EXCEPTION;
 o HIERARCHY_REQUEST_ERR EXCEPTION;
 o WRONG_DOCUMENT_ERR EXCEPTION;
 o INVALID_CHARACTER_ERR EXCEPTION;
 o NO_DATA_ALLOWED_ERR EXCEPTION;
 o NO_MODIFICATION_ALLOWED_ERR EXCEPTION;
 o NOT_FOUND_ERR EXCEPTION;
 o NOT_SUPPORTED_ERR EXCEPTION;
 o INUSE_ATTRIBUTE_ERR EXCEPTION;

DOM interface types description

 o TYPE DOMNode IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMNamedNodeMap IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMNodeList IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMAttr IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMCDataSection IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMCharacterData IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMComment IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMDocumentFragment IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMElement IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMEntity IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMEntityReference IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMNotation IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMProcessingInstruction IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMText IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMImplementation IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMDocumentType IS RECORD ( ID VARCHAR2(5) );
 o TYPE DOMDocument IS RECORD ( ID VARCHAR2(5) );

Method Prototypes

Node methods

 o FUNCTION isNull(n DOMNode) RETURN BOOLEAN;

PURPOSE

Checks if the given DOMNode is null

SYNTAX

 FUNCTION isNull(n DOMNode) RETURN BOOLEAN; 

PARAMETERS

 n      (IN)-  DOMNode to check

RETURNS

Whether given DOMNode is null: TRUE - is null, FALSE - is not null

 o FUNCTION makeAttr(n DOMNode) RETURN DOMAttr;

PURPOSE

Casts given DOMNode to a DOMAttr

SYNTAX

 FUNCTION makeAttr(n DOMNode) RETURN DOMAttr; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMAttr

 o FUNCTION makeCDataSection(n DOMNode) RETURN DOMCDataSection;

PURPOSE

Casts given DOMNode to a DOMCDataSection

SYNTAX

 FUNCTION makeCDataSection(n DOMNode) RETURN DOMCDataSection; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMCDataSection

 o FUNCTION makeCharacterData(n DOMNode) RETURN DOMCharacterData;

PURPOSE

Casts given DOMNode to a DOMCharacterData

SYNTAX

 FUNCTION makeCharacterData(n DOMNode) RETURN DOMCharacterData; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMCharacterData

 o FUNCTION makeComment(n DOMNode) RETURN DOMComment;

PURPOSE

Casts given DOMNode to a DOMComment

SYNTAX

 FUNCTION makeComment(n DOMNode) RETURN DOMComment; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMComment

 o FUNCTION makeDocumentFragment(n DOMNode) RETURN DOMDocumentFragment;

PURPOSE

Casts given DOMNode to a DOMDocumentFragment

SYNTAX

 FUNCTION makeDocumentFragment(n DOMNode) RETURN DOMDocumentFragment; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMDocumentFragment

 o FUNCTION makeDocumentType(n DOMNode) RETURN DOMDocumentType;

PURPOSE

Casts given DOMNode to a DOMDocumentType

SYNTAX

 FUNCTION makeDocumentType(n DOMNode) RETURN DOMDocumentType; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMDocumentType

 o FUNCTION makeElement(n DOMNode) RETURN DOMElement;

PURPOSE

Casts given DOMNode to a DOMElement

SYNTAX

 FUNCTION makeElement(n DOMNode) RETURN DOMElement; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMElement

 o FUNCTION makeEntity(n DOMNode) RETURN DOMEntity;

PURPOSE

Casts given DOMNode to a DOMEntity

SYNTAX

 FUNCTION makeEntity(n DOMNode) RETURN DOMEntity; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMEntity

 o FUNCTION makeEntityReference(n DOMNode) RETURN DOMEntityReference;

PURPOSE

Casts given DOMNode to a DOMEntityReference

SYNTAX

 FUNCTION makeEntityReference(n DOMNode) RETURN DOMEntityReference; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMEntityReference

 o FUNCTION makeNotation(n DOMNode) RETURN DOMNotation;

PURPOSE

Casts given DOMNode to a DOMNotation

SYNTAX

 FUNCTION makeNotation(n DOMNode) RETURN DOMNotation; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMNotation

 o FUNCTION makeProcessingInstruction(n DOMNode) RETURN DOMProcessingInstruction;

PURPOSE

Casts given DOMNode to a DOMProcessingInstruction

SYNTAX

 FUNCTION makeProcessingInstruction(n DOMNode) RETURN DOMProcessingInstruction; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMProcessingInstruction

 o FUNCTION makeText(n DOMNode) RETURN DOMText;

PURPOSE

Casts given DOMNode to a DOMText

SYNTAX

 FUNCTION makeText(n DOMNode) RETURN DOMText; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMText

 o FUNCTION makeDocument(n DOMNode) RETURN DOMDocument;

PURPOSE

Casts given DOMNode to a DOMDocument

SYNTAX

 FUNCTION makeDocument(n DOMNode) RETURN DOMDocument; 

PARAMETERS

 n      (IN)-  DOMNode to cast

RETURNS

The DOMDocument

 o PROCEDURE writeToFile(n DOMNode, fileName VARCHAR2);

PURPOSE

Writes XML node to specified file using the database character set

SYNTAX

 PROCEDURE writeToFile(n DOMNode, fileName VARCHAR2); 

PARAMETERS

 n        (IN)-  DOMNode
 fileName (IN)-  File to write to

RETURNS

Nothing.
 o PROCEDURE writeToBuffer(n DOMNode, buffer IN OUT VARCHAR2);

PURPOSE

Writes XML node to specified buffer using the database character set

SYNTAX

 PROCEDURE writeToBuffer(n DOMNode, buffer IN OUT VARCHAR2); 

PARAMETERS

 n        (IN)-  DOMNode
 buffer   (OUT)- buffer to write to

RETURNS

Nothing.

 o PROCEDURE writeToClob(n DOMNode, cl IN OUT CLOB);

PURPOSE

Writes XML node to specified clob using the database character set

SYNTAX

 PROCEDURE writeToClob(n DOMNode, cl IN OUT CLOB); 

PARAMETERS

 n        (IN)-  DOMNode
 cl      (OUT)-  CLOB to write to

RETURNS

Nothing.

 o PROCEDURE writeToFile(n DOMNode, fileName VARCHAR2, charset VARCHAR2);

PURPOSE

Writes XML node to specified file using the given character set

SYNTAX

 PROCEDURE writeToFile(n DOMNode, fileName VARCHAR2, charset VARCHAR2); 

PARAMETERS

 n        (IN)-  DOMNode
 fileName (IN)-  File to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeToBuffer(n DOMNode, buffer IN OUT VARCHAR2, charset VARCHAR2);

PURPOSE

Writes XML node to specified buffer using the given character set

SYNTAX

 PROCEDURE writeToBuffer(n DOMNode, buffer IN OUT VARCHAR2, charset VARCHAR2); 

PARAMETERS

 n        (IN)-  DOMNode
 buffer   (OUT)- buffer to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeToClob(n DOMNode, cl IN OUT CLOB, charset VARCHAR2);

PURPOSE

Writes XML node to specified clob using the given character set

SYNTAX

 PROCEDURE writeToClob(n DOMNode, cl IN OUT CLOB, charset VARCHAR2); 

PARAMETERS

 n        (IN)-  DOMNode
 cl      (OUT)-  CLOB to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

NamedNodeMap methods

 o FUNCTION isNull(nnm DOMNamedNodeMap) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM NamedNodeMap is null

SYNTAX

 FUNCTION isNull(nnm DOMNamedNodeMap) RETURN BOOLEAN; 

PARAMETERS

 nnm      (IN)-  DOMNamedNodeMap to check

RETURNS

Whether given DOM NamedNodeMap is null: TRUE - is null, FALSE - is not null

NodeList methods

 o FUNCTION isNull(nl DOMNodeList) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM NodeList is null

SYNTAX

 FUNCTION isNull(nl DOMNodeList) RETURN BOOLEAN; 

PARAMETERS

 nl      (IN)-  DOMNodeList to check

RETURNS

Whether given DOM NodeList is null: TRUE - is null, FALSE - is not null

Attr methods

 o FUNCTION isNull(a DOMAttr) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM Attr is null

SYNTAX

 FUNCTION isNull(a DOMAttr) RETURN BOOLEAN; 

PARAMETERS

 a      (IN)-  DOMAttr to check

RETURNS

Whether given DOM Attr is null: TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(a DOMAttr) RETURN DOMNode;

PURPOSE

Casts given DOMAttr to a DOMNode

SYNTAX

 FUNCTION makeNode(a DOMAttr) RETURN DOMNode; 

PARAMETERS

 a      (IN)-  DOMNode to cast

RETURNS

The DOMNode

 o FUNCTION getQualifiedName(a DOMAttr) RETURN VARCHAR2;

PURPOSE

Returns the qualified name of the DOMAttr

SYNTAX

 FUNCTION getQualifiedName(a DOMAttr) RETURN VARCHAR2; 

PARAMETERS

 a      (IN)-  DOMAttr

RETURNS

The qualified name

 o FUNCTION getNamespace(a DOMAttr) RETURN VARCHAR2;

PURPOSE

Returns the namespace of the DOMAttr

SYNTAX

 FUNCTION getNamespace(a DOMAttr) RETURN VARCHAR2; 

PARAMETERS

 a      (IN)-  DOMAttr

RETURNS

The namespace

 o FUNCTION getLocalName(a DOMAttr) RETURN VARCHAR2;

PURPOSE

Returns the local name of the DOMAttr

SYNTAX

 FUNCTION getLocalName(a DOMAttr) RETURN VARCHAR2; 

PARAMETERS

 a      (IN)-  DOMAttr

RETURNS

The local name

 o FUNCTION getExpandedName(a DOMAttr) RETURN VARCHAR2;

PURPOSE

Returns the expanded name of the DOMAttr

SYNTAX

 FUNCTION getExpandedName(a DOMAttr) RETURN VARCHAR2; 

PARAMETERS

 a      (IN)-  DOMAttr

RETURNS

The expanded name

CDataSection methods

 o FUNCTION isNull(cds DOMCDataSection) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM CDataSection is null

SYNTAX

 FUNCTION isNull(cds DOMCDataSection) RETURN BOOLEAN; 

PARAMETERS

 cds      (IN)-  DOMCDataSection to check

RETURNS

Whether given DOM CDataSection is null: TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(cds DOMCDataSection) RETURN DOMNode;

PURPOSE

Casts given DOMCDataSection to a DOMNode

SYNTAX

 FUNCTION makeNode(cds DOMCDataSection) RETURN DOMNode; 

PARAMETERS

 cds      (IN)-  DOMCDataSection to cast

RETURNS

The DOMNode

CharacterData methods

 o FUNCTION isNull(cd DOMCharacterData) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM CharacterData is null

SYNTAX

 FUNCTION isNull(cd DOMCharacterData) RETURN BOOLEAN; 

PARAMETERS

 cd      (IN)-  DOMCharacterData to check

RETURNS

Whether given DOM CharacterData is null : TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(cd DOMCharacterData) RETURN DOMNode;

PURPOSE

Casts given DOMCharacterData to a DOMNode

SYNTAX

 FUNCTION makeNode(cd DOMCharacterData) RETURN DOMNode; 

PARAMETERS

 cd      (IN)-  DOMCharacterData to cast

RETURNS

The DOMNode

Comment methods

 o FUNCTION isNull(com DOMComment) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM Comment is null

SYNTAX

 FUNCTION isNull(com DOMComment) RETURN BOOLEAN; 

PARAMETERS

 com      (IN)-  DOMComment to check

RETURNS

Whether given DOM Comment is null: TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(com DOMComment) RETURN DOMNode;

PURPOSE

Casts given DOMComment to a DOMNode

SYNTAX

 FUNCTION makeNode(com DOMComment) RETURN DOMNode; 

PARAMETERS

 com      (IN)-  DOMComment to ast

RETURNS

The DOMComment

DOMImplementation methods

 o FUNCTION isNull(di DOMImplementation) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM Implementation is null

SYNTAX

 FUNCTION isNull(di DOMImplementation) RETURN BOOLEAN; 

PARAMETERS

 di      (IN)-  DOMImplementation to check

RETURNS

Whether given DOM Implementation is null: TRUE - is null, FALSE - is not null

DocumentFragment methods

 o FUNCTION isNull(df DOMDocumentFragment) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM DocumentFragment is null

SYNTAX

 FUNCTION isNull(df DOMDocumentFragment) RETURN BOOLEAN; 

PARAMETERS

 df      (IN)-  DOMDocumentFragment to check

RETURNS

Whether given DOM DocumentFragment is null: TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(df DOMDocumentFragment) RETURN DOMComment;

PURPOSE

Casts given DOMDocumentFragment to a DOMNode

SYNTAX

 FUNCTION makeNode(df DOMDocumentFragment) RETURN DOMNode; 

PARAMETERS

 df      (IN)-  DOMDocumentFragment to cast

RETURNS

The DOMNode

DocumentType methods

 o FUNCTION isNull(dt DOMDocumentType) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM DocumentType is null

SYNTAX

 FUNCTION isNull(dt DOMDocumentType) RETURN BOOLEAN; 

PARAMETERS

 dt      (IN)-  DOMDocumentType to check

RETURNS

Whether given DOM DocumentType is null: TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(dt DOMDocumentType) RETURN DOMNode;

PURPOSE

Casts given DOMDocumentType to a DOMNode

SYNTAX

 FUNCTION makeNode(dt DOMDocumentType) RETURN DOMNode; 

PARAMETERS

 dt      (IN)-  DOMDocumentType to cast

RETURNS

The DOMNode

 o FUNCTION findEntity(dt DOMDocumentType, name VARCHAR2, par BOOLEAN) RETURN DOMEntity;

PURPOSE

Finds an entity in the given DTD

SYNTAX

 FUNCTION findEntity(dt DOMDocumentType, name VARCHAR2, par BOOLEAN) RETURN DOMEntity; 

PARAMETERS

 dt      (IN)-  DTD
 name    (IN)-  entity to find
 par     (IN)-  TRUE - parameter entity, FALSE - normal entity

RETURNS

The DOMEntity, if found.

 o FUNCTION findNotation(dt DOMDocumentType, name VARCHAR2) RETURN DOMNotation;

PURPOSE

Finds a notation in the given DTD

SYNTAX

 FUNCTION findNotation(dt DOMDocumentType, name VARCHAR2) RETURN DOMNotation; 

PARAMETERS

 dt      (IN)-  DTD
 name    (IN)-  notation to find

RETURNS

The DOMNotation, if found.

 o FUNCTION getPublicId(dt DOMDocumentType) RETURN VARCHAR2;

PURPOSE

Return the public id of the given DTD

SYNTAX

 FUNCTION getPublicId(dt DOMDocumentType) RETURN VARCHAR2; 

PARAMETERS

 dt      (IN)-  DTD

RETURNS

The public id

 o FUNCTION getSystemId(dt DOMDocumentType) RETURN VARCHAR2;

PURPOSE

Return the system id of the given DTD

SYNTAX

 FUNCTION getSystemId(dt DOMDocumentType) RETURN VARCHAR2; 

PARAMETERS

 dt      (IN)-  DTD

RETURNS

The system id

 o PROCEDURE writeExternalDTDToFile(dt DOMDocumentType, fileName VARCHAR2);

PURPOSE

Writes DTD to specified file using the database character set

SYNTAX

 PROCEDURE writeExternalDTDToFile(dt DOMDocumentType, fileName VARCHAR2); 

PARAMETERS

 dt       (IN)-  DOMDocumentType
 fileName (IN)-  File to write to

RETURNS

Nothing.
 o PROCEDURE writeExternalDTDToBuffer(dt DOMDocumentType, buffer IN OUT VARCHAR2);

PURPOSE

Writes DTD to specified buffer using the database character set

SYNTAX

 PROCEDURE writeExternalDTDToBuffer(dt DOMDocumentType, buffer IN OUT VARCHAR2); 

PARAMETERS

 dt       (IN)-  DOMDocumentType
 buffer   (OUT)- buffer to write to

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToClob(dt DOMDocumentType, cl IN OUT CLOB);

PURPOSE

Writes DTD to specified clob using the database character set

SYNTAX

 PROCEDURE writeExternalDTDToClob(dt DOMDocumentType, cl IN OUT CLOB); 

PARAMETERS

 dt       (IN)-  DOMDocumentType
 cl      (OUT)-  CLOB to write to

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToFile(dt DOMDocumentType, fileName VARCHAR2, charset VARCHAR2);

PURPOSE

Writes DTD to specified file using the given character set

SYNTAX

 PROCEDURE writeExternalDTDToFile(dt DOMDocumentType, fileName VARCHAR2, charset VARCHAR2); 

PARAMETERS

 dt       (IN)-  DOMDocumentType
 fileName (IN)-  File to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToBuffer(dt DOMDocumentType, buffer IN OUT VARCHAR2, charset VARCHAR2);

PURPOSE

Writes DTD to specified buffer using the given character set

SYNTAX

 PROCEDURE writeExternalDTDToBuffer(dt DOMDocumentType, buffer IN OUT VARCHAR2, charset VARCHAR2); 

PARAMETERS

 dt       (IN)-  DOMDocumentType
 buffer   (OUT)- buffer to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToClob(dt DOMDocumentType, cl IN OUT CLOB, charset VARCHAR2);

PURPOSE

Writes DTD to specified clob using the given character set

SYNTAX

 PROCEDURE writeExternalDTDToClob(dt DOMDocumentType, cl IN OUT CLOB, charset VARCHAR2); 

PARAMETERS

 dt       (IN)-  DOMDocumentType
 cl      (OUT)-  CLOB to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

Element methods

 o FUNCTION isNull(elem DOMElement) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM Element is null

SYNTAX

 FUNCTION isNull(elem DOMElement) RETURN BOOLEAN; 

PARAMETERS

 elem      (IN)-  DOMElement to check

RETURNS

Whether given DOM Element is null: TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(elem DOMElement) RETURN DOMNode;

PURPOSE

Casts given DOMElement to a DOMNode

SYNTAX

 FUNCTION makeNode(elem DOMElement) RETURN DOMNode; 

PARAMETERS

 elem      (IN)-  DOMElement to cast

RETURNS

The DOMNode

 o FUNCTION getQualifiedName(elem DOMElement) RETURN VARCHAR2;

PURPOSE

Returns the qualified name of the DOMElem

SYNTAX

 FUNCTION getQualifiedName(elem DOMElement) RETURN VARCHAR2; 

PARAMETERS

 elem      (IN)-  DOMElement

RETURNS

The qualified name

 o FUNCTION getNamespace(elem DOMElement) RETURN VARCHAR2;

PURPOSE

Returns the namespace of the DOMElem

SYNTAX

 FUNCTION getNamespace(elem DOMElement) RETURN VARCHAR2; 

PARAMETERS

 elem      (IN)-  DOMElement

RETURNS

The namespace

 o FUNCTION getLocalName(elem DOMElement) RETURN VARCHAR2;

PURPOSE

Returns the local name of the DOMElem

SYNTAX

 FUNCTION getLocalName(elem DOMElement) RETURN VARCHAR2; 

PARAMETERS

 elem      (IN)-  DOMElement

RETURNS

The local name

 o FUNCTION getExpandedName(elem DOMElement) RETURN VARCHAR2;

PURPOSE

Returns the expanded name of the DOMElem

SYNTAX

 FUNCTION getExpandedName(elem DOMElement) RETURN VARCHAR2; 

PARAMETERS

 elem      (IN)-  DOMElement

RETURNS

The expanded name

 o FUNCTION getChildrenByTagName(elem DOMElement, name varchar2) RETURN DOMNodeList;

PURPOSE

Returns the children of the DOMElem having the given tag name

SYNTAX

 FUNCTION getChildrenByTagName(elem DOMElement, name varchar2) RETURN DOMNodeList; 

PARAMETERS

 elem      (IN)-  DOMElement
 name      (IN)-  tag name (* matches any tag)

RETURNS

Children with the given tag name

 o FUNCTION getElementsByTagName(elem DOMElement, name varchar2, ns VARCHAR2) RETURN DOMNodeList;

PURPOSE

Returns the element children of the DOMElem having the given tag name and namespace

SYNTAX

 FUNCTION getElementsByTagName(elem DOMElement, name varchar2, ns VARCHAR2 ) RETURN DOMNodeList; 

PARAMETERS

 elem      (IN)-  DOMElement
 name      (IN)-  tag name (* matches any tag)
 ns        (IN)-  namespace

RETURNS

Elements with the given tag name and namespace

 o FUNCTION getChildrenByTagName(elem DOMElement, name varchar2, ns VARCHAR2) RETURN DOMNodeList;

PURPOSE

Returns the children of the DOMElem having the given tag name and namespace

SYNTAX

 FUNCTION getChildrenByTagName(elem DOMElement, name varchar2, ns VARCHAR2 ) RETURN DOMNodeList; 

PARAMETERS

 elem      (IN)-  DOMElement
 name      (IN)-  tag name (* matches any tag)
 ns        (IN)-  namespace

RETURNS

Children with the given tag name and namespace

 o FUNCTION resolveNamespacePrefix(elem DOMElement, prefix VARCHAR2) RETURN VARCHAR2;

PURPOSE

Resolves the given namespace prefix

SYNTAX

 FUNCTION resolveNamespacePrefix(elem DOMElement, prefix VARCHAR2) RETURN VARCHAR2; 

PARAMETERS

 elem      (IN)-  DOMElement
 prefix    (IN)-  namespace prefix

RETURNS

The resolved namespace

Entity methods

 o FUNCTION isNull(ent DOMEntity) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM Entity is null

SYNTAX

 FUNCTION isNull(ent DOMEntity) RETURN BOOLEAN; 

PARAMETERS

 ent      (IN)-  DOMEntity to check

RETURNS

Whether given DOM Entity is null: TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(ent DOMEntity) RETURN DOMNode;

PURPOSE

Casts given DOMEntity to a DOMNode

SYNTAX

 FUNCTION makeNode(ent DOMEntity) RETURN DOMNode; 

PARAMETERS

 ent      (IN)-  DOMEntity to cast

RETURNS

The DOMNode

EntityReference methods

 o FUNCTION isNull(eref DOMEntityReference) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM EntityReference is null

SYNTAX

 FUNCTION isNull(eref DOMEntityReference) RETURN BOOLEAN; 

PARAMETERS

 eref      (IN)-  DOMEntityReference to check

RETURNS

Whether given DOM EntityReference is null : TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(eref DOMEntityReference) RETURN DOMNode;

PURPOSE

Casts given DOMEntityReference to a DOMNode

SYNTAX

 FUNCTION makeNode(eref DOMEntityReference) RETURN DOMNode; 

PARAMETERS

 eref      (IN)-  DOMEntityReference to cast

RETURNS

The DOMNode

Notation methods

 o FUNCTION isNull(n DOMNotation) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM Notation is null

SYNTAX

 FUNCTION isNull(n DOMNotation) RETURN BOOLEAN; 

PARAMETERS

 n      (IN)-  DOMNotation to check

RETURNS

Whether given DOM Notation is null : TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(n DOMNotation) RETURN DOMNode;

PURPOSE

Casts given DOMNotation to a DOMNode

SYNTAX

 FUNCTION makeNode(n DOMNotation) RETURN DOMNode; 

PARAMETERS

 n      (IN)-  DOMNotation to cast

RETURNS

The DOMNode

ProcessingInstruction methods

 o FUNCTION isNull(pi DOMProcessingInstruction) RETURN BOOLEAN;

PURPOSE

Checks if the given DOM ProcessingInstruction is null

SYNTAX

 FUNCTION isNull(pi DOMProcessingInstruction) RETURN BOOLEAN; 

PARAMETERS

 pi      (IN)-  DOMProcessingInstruction to check

RETURNS

Whether given DOM ProcessingInstruction is null : TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(pi DOMProcessingInstruction) RETURN DOMNode;

PURPOSE

Casts given DOMProcessingInstruction to a DOMNode

SYNTAX

 FUNCTION makeNode(pi DOMProcessingInstruction) RETURN DOMNode; 

PARAMETERS

 pi      (IN)-  DOMProcessingInstruction to cast

RETURNS

The DOMNode

Text methods

 o FUNCTION isNull(t DOMText) RETURN BOOLEAN;

PURPOSE

Checks if the given DOMText is null

SYNTAX

 FUNCTION isNull(t DOMText) RETURN BOOLEAN;

PARAMETERS

 t      (IN)-  DOMText to check

RETURNS

Whether given DOMText is null : TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(t DOMText) RETURN DOMNode;

PURPOSE

Casts given DOMText to a DOMNode

SYNTAX

 FUNCTION makeNode(t DOMText) RETURN DOMNode; 

PARAMETERS

 t      (IN)-  DOMText to cast

RETURNS

The DOMNode

Document methods

 o FUNCTION isNull(doc DOMDocument) RETURN BOOLEAN;

PURPOSE

Checks if the given DOMDocument is null

SYNTAX

 FUNCTION isNull(doc DOMDocument) RETURN BOOLEAN;

PARAMETERS

 doc      (IN)-  DOMDocument to check

RETURNS

Whether given DOMDocument is null : TRUE - is null, FALSE - is not null

 o FUNCTION makeNode(doc DOMDocument) RETURN DOMNode;

PURPOSE

Casts given DOMDocument to a DOMNode

SYNTAX

 FUNCTION makeNode(doc DOMDocument) RETURN DOMNode; 

PARAMETERS

 doc      (IN)-  DOMDocument to cast

RETURNS

The DOMNode

 o FUNCTION newDOMDocument RETURN DOMDocument;

PURPOSE

Returns a new DOM Document instance

SYNTAX

 FUNCTION newDOMDocument RETURN DOMDocument; 

PARAMETERS

None

RETURNS

A new DOMDocument instance

 o PROCEDURE freeDocument(doc DOMDocument)

PURPOSE

Frees Document object

SYNTAX

 PROCEDURE freeDocument(doc DOMDocument) 

PARAMETERS

 doc      (IN)-  DOMDocument
 o FUNCTION getVersion(doc DOMDocument) RETURN VARCHAR2;

PURPOSE

Gets version information for the XML document

SYNTAX

 FUNCTION getVersion(doc DOMDocument) RETURN VARCHAR2; 

PARAMETERS

 doc      (IN)-  DOMDocument

RETURNS

Version information

 o PROCEDURE setVersion(doc DOMDocument, version VARCHAR2);

PURPOSE

Sets version information for the XML document

SYNTAX

 PROCEDURE setVersion(doc DOMDocument, version VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 version  (IN)-  version information

RETURNS

Nothing.

 o FUNCTION getCharset(doc DOMDocument) RETURN VARCHAR2;

PURPOSE

Gets character set of the XML document

SYNTAX

 FUNCTION getCharset(doc DOMDocument) RETURN VARCHAR2; 

PARAMETERS

 doc      (IN)-  DOMDocument

RETURNS

Character set of the XML document

 o PROCEDURE setCharset(doc DOMDocument, charset VARCHAR2);

PURPOSE

Sets character set of the XML document

SYNTAX

 PROCEDURE setCharset(doc DOMDocument, charset VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 charset  (IN)-  Character set

RETURNS

Nothing.

 o FUNCTION getStandalone(doc DOMDocument) RETURN VARCHAR2;

PURPOSE

Gets standalone information for the XML document

SYNTAX

 FUNCTION getStandalone(doc DOMDocument) RETURN VARCHAR2; 

PARAMETERS

 doc      (IN)-  DOMDocument

RETURNS

Standalone information

 o PROCEDURE setStandalone(doc DOMDocument, value VARCHAR2);

PURPOSE

Sets standalone information for the XML document

SYNTAX

 PROCEDURE setStandalone(doc DOMDocument, value VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 value    (IN)-  standalone information

RETURNS

Nothing.

 o PROCEDURE writeToFile(doc DOMDocument, fileName VARCHAR2);

PURPOSE

Writes XML document to specified file using the database character set

SYNTAX

 PROCEDURE writeToFile(doc DOMDocument, fileName VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 fileName (IN)-  File to write to

RETURNS

Nothing.

 o PROCEDURE writeToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2);

PURPOSE

Writes XML document to specified buffer using the database character set

SYNTAX

 PROCEDURE writeToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 buffer   (OUT)- buffer to write to

RETURNS

Nothing.

 o PROCEDURE writeToClob(doc DOMDocument, cl IN OUT CLOB);

PURPOSE

Writes XML document to specified clob using the database character set

SYNTAX

 PROCEDURE writeToClob(doc DOMDocument, cl IN OUT CLOB); 

PARAMETERS

 doc      (IN)-  DOMDocument
 cl      (OUT)-  CLOB to write to

RETURNS

Nothing.

 o PROCEDURE writeToFile(doc DOMDocument, fileName VARCHAR2, charset VARCHAR2);

PURPOSE

Writes XML document to specified file using the given character set

SYNTAX

 PROCEDURE writeToFile(doc DOMDocument, fileName VARCHAR2, charset VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 fileName (IN)-  File to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2, charset VARCHAR2);

PURPOSE

Writes XML document to specified buffer using the given character set

SYNTAX

 PROCEDURE writeToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2, charset VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 buffer   (OUT)- buffer to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeToClob(doc DOMDocument, cl IN OUT CLOB, charset VARCHAR2);

PURPOSE

Writes XML document to specified clob using the given character set

SYNTAX

 PROCEDURE writeToClob(doc DOMDocument, cl IN OUT CLOB, charset VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 cl      (OUT)-  CLOB to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToFile(doc DOMDocument, fileName VARCHAR2);

PURPOSE

Writes an external DTD to specified file using the database character set

SYNTAX

 PROCEDURE writeExternalDTDToFile(doc DOMDocument, fileName VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 fileName (IN)-  File to write to

RETURNS

Nothing.
 o PROCEDURE writeExternalDTDToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2);

PURPOSE

Writes an external DTD to specified buffer using the database character set

SYNTAX

 PROCEDURE writeExternalDTDToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 buffer   (OUT)- buffer to write to

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToClob(doc DOMDocument, cl IN OUT CLOB);

PURPOSE

Writes an external DTD to specified clob using the database character set

SYNTAX

 PROCEDURE writeExternalDTDToClob(doc DOMDocument, cl IN OUT CLOB); 

PARAMETERS

 doc      (IN)-  DOMDocument
 cl      (OUT)-  CLOB to write to

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToFile(doc DOMDocument, fileName VARCHAR2, charset VARCHAR2);

PURPOSE

Writes an external DTD to specified file using the given character set

SYNTAX

 PROCEDURE writeExternalDTDToFile(doc DOMDocument, fileName VARCHAR2, charset VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 fileName (IN)-  File to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2, charset VARCHAR2);

PURPOSE

Writes an external DTD to specified buffer using the given character set

SYNTAX

 PROCEDURE writeExternalDTDToBuffer(doc DOMDocument, buffer IN OUT VARCHAR2, charset VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 buffer   (OUT)- buffer to write to
 charset  (IN)-  Character set

RETURNS

Nothing.

 o PROCEDURE writeExternalDTDToClob(doc DOMDocument, cl IN OUT CLOB, charset VARCHAR2);

PURPOSE

Writes an external DTD to specified clob using the given character set

SYNTAX

 PROCEDURE writeExternalDTDToClob(doc DOMDocument, cl IN OUT CLOB, charset VARCHAR2); 

PARAMETERS

 doc      (IN)-  DOMDocument
 cl      (OUT)-  CLOB to write to
 charset  (IN)-  Character set

RETURNS

Nothing.