XML C++ API Reference
11g Release 2 (11.2)
E10771-01
July 2009
Oracle Database XML C++ API Reference, 11g Release 2 (11.2)
E10771-01
Copyright © 2001, 2009, Oracle and/or its affiliates. All rights reserved.
Primary Author: Roza Leyderman
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
This reference describes Oracle XML Developer's Kits (XDK) and Oracle XML DB APIs for the C programming language. It primarily lists the syntax of functions, methods, and procedures associated with these APIs.
This guide is intended for developers building XML applications in Oracle.
To use this document, you need a basic understanding of object-oriented programming concepts, familiarity with Structured Query Language (SQL), and working knowledge of application development using the C programming language.
Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.
Accessibility of Code Examples in Documentation
Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.
Accessibility of Links to External Web Sites in Documentation
This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.
Deaf/Hard of Hearing Access to Oracle Support Services
To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at http://www.fcc.gov/cgb/consumerfacts/trs.html, and a list of phone numbers is available at http://www.fcc.gov/cgb/dro/trsphonebk.html.
For more information, see the following documents in the Oracle Database the 11g Release 2 (11.2) documentation set:
The following text conventions are used in this document:
| Convention | Meaning |
|---|---|
| boldface | Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary. |
| italic | Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values. |
monospace | Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter. |
XPath package contains XPath processing related types and interfaces.
This chapter contains the following sections:
Table 8-1 summarizes the datatypes of the XPath package.
Table 8-1 Summary of Datatypes; XPath Package
| Datatype | Description |
|---|---|
|
|
Defines XPath compiler identifiers. |
|
|
Defines object types for XPath 1.0 based implementations. |
|
|
XPath related exception codes. |
|
|
Defines XPath processor identifiers. |
Defines XPath compiler identifiers.
Definition
typedef enum XPathCompIdType {
XvmXPathCompCXml = 1
} XPathCompIdType;
Defines object types for XPath 1.0 based implementations.
Definition
typedef enum XPathObjType {
XPOBJ_TYPE_UNKNOWN = 0,
XPOBJ_TYPE_NDSET = 1,
XPOBJ_TYPE_BOOL = 2,
XPOBJ_TYPE_NUM = 3,
XPOBJ_TYPE_STR = 4
} XPathObjType;
XPath related exception codes.
Definition
typedef enum XPathExceptionCode {
XPATH_UNDEFINED_ERR = 0,
XPATH_OTHER_ERR = 1
} XPathExceptionCode;
Defines XPath processor identifiers.
Definition
typedef enum XPathPrIdType { XPathPrCXml = 1, XvmPrCXml = 2 } XPathPrIdType;
Table 8-2 summarizes the methods available through the CompProcessor interface.
Table 8-2 Summary of CompProcessor Methods; XPath Package
| Function | Summary |
|---|---|
|
|
Get processor's Id. |
|
|
Evaluate XPath expression against given document. |
|
|
Evaluate compiled XPath expression against given document. |
Get processor Id.
Syntax
virtual XPathPrIdType getProcessorId() const = 0;
Returns
(XPathPrIdType) Processor's Id
Inherited from Processor.
Syntax
virtual XPathObject< Node>* process ( InputSource* isrc_ptr, oratext* xpath_exp) throw (XPathException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | instance document to process |
xpath_exp | XPATH expression |
Returns
(XPathGenObject*) XPath object
Evaluates compiled XPath expression against given document.
Syntax
virtual XPathObject< Node>* processWithBinXPath ( InputSource* isrc_ptr, ub2* bin_xpath) throw (XPathException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | instance document to process |
bin_xpath | compiled XPATH expression |
Returns
(XPathGenObject*) XPath object
Table 8-3 summarizes the methods available through the Compiler interface.
Table 8-3 Summary of Compiler Methods; XPath Package
| Function | Summary |
|---|---|
|
|
Compile XPath and return its compiled binary representation. |
|
|
Get the compiler's Id |
Compiles XPath and returns its compiled binary representation.
Syntax
virtual ub2* compile ( oratext* xpath_exp) throw (XPathException) = 0;
| Parameter | Description |
|---|---|
xpath_exp | XPATH expression |
Returns
(ub2) XPath expression in compiled binary representation
Get compiler's id.
Syntax
virtual XPathCompIdType getCompilerId() const = 0;
Returns
(XPathCompIdType) Compiler's Id
Table 8-4 summarizes the methods available through the NodeSet interface.
Table 8-4 Summary of NodeSet Methods; XPath Package
| Function | Summary |
|---|---|
|
|
Get node given its index. |
|
|
Get |
Returns a reference to the node.
Syntax
NodeRef< Node>* getNode( ub4 idx) const;
| Parameter | Description |
|---|---|
idx | index of the node in the set |
Returns
(NodeRef) reference to the node
The size of the node set.
Syntax
ub4 getSize() const;
Returns
(ub4) node set size
Table 8-5 summarizes the methods available through the Processor interface.
Table 8-5 Summary of Processor Methods; XPath Package
| Function | Summary |
|---|---|
|
|
Get processor's Id. |
|
|
Evaluate XPath expression against given document. |
Get processor Id.
Syntax
virtual XPathPrIdType getProcessorId() const = 0;
Returns
(XPathPrIdType) Processor's Id
Evaluates XPath expression against given document and returns result XPath object.
Syntax
virtual XPathObject< Node>* process ( InputSource* isrc_ptr, oratext* xpath_exp) throw (XPathException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | instance document to process |
xpath_exp | XPath expression |
Returns
(XPathGenObject*) XPath object
Table 8-6 summarizes the methods available through the XPathException interface.
Table 8-6 Summary of XPathException Methods; XPath Package
| Function | Summary |
|---|---|
|
|
Get Oracle XML error code embedded in the exception. |
|
|
Get current language (encoding) of error messages. |
|
|
Get Oracle XML error message. |
|
|
Get XPath exception code embedded in the exception. |
Virtual member function inherited from XmlException.
Syntax
virtual unsigned getCode() const = 0;
Returns
(unsigned) numeric error code (0 on success)
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext*) Current language (encoding) of error messages
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
This is a virtual member function that defines a prototype for implementation defined member functions returning XPath processor and compiler exception codes, defined in XPathExceptionCode, of the exceptional situations during execution.
Syntax
virtual XPathExceptionCode getXPathCode() const = 0;
Returns
(XPathExceptionCode) exception code
Table 8-7 summarizes the methods available through the XPathObject interface.
Table 8-7 Summary of XPathObject Methods; XPath Package
| Function | Summary |
|---|---|
|
|
Copy constructor. |
|
|
Get the node set. |
|
|
Get boolean from object. |
|
|
Get number from object. |
|
|
Get string from object. |
|
|
Get type from object. |
Copy constructor.
Syntax
XPathObject( XPathObject< Node>& src);
| Parameter | Description |
|---|---|
src | reference to the object to be copied |
Returns
(XPathObject) new object
Get the node set.
Syntax
NodeSet< Node>* getNodeSet() const;
Get the boolean from the object.
Syntax
boolean getObjBoolean() const;
Get the number from the object.
Syntax
double getObjNumber() const;
Get the string from the object.
Syntax
oratext* getObjString() const;
Get the type from the object.
Syntax
XPathObjType getObjType() const;
Interfaces in this package represent DOM level 2 Core interfaces according to http://www.w3.org/TR/DOM-Level-2-Core/.
This chapter contains the following sections:
DOM interfaces are represented as generic references to different implementations of the DOM specifications. They are parameterized by Node, which supports various specializations and instantiations. Of them, the most important is xmlnode that corresponds to the current C implementation.
These generic references do not have a NULL-like value. Any implementation should never create a stateless reference. If there is need to signal that something has no state, an exception should be thrown.
Many methods might throw the SYNTAX_ERR exception, if the DOM tree is incorrectly formed, or UNDEFINED_ERR, in the case of wrong parameters or unexpected NULL pointers. If these are the only errors that a particular method might throw, it is not reflected in the method signature.
Actual DOM trees do not dependent on the context (TCtx). However, manipulations on DOM trees in the current, xmlctx based implementation require access to the current context (TCtx). This is accomplished by passing the context pointer to the constructor of DOMImplRef. In multithreaded environment DOMImplRef is always created in the thread context and, so, has the pointer to the right context.
DOMImplRef providea a way to create DOM trees. DomImplRef is a reference to the actual DOMImplementation object that is created when a regular, non-copy constructor of DomImplRef is invoked. This works well in multithreaded environment where DOM trees need to be shared, and each thread has a separate TCtx associated with it. This works equally well in a single threaded environment.
DOMString is only one of encodings supported by Oracle implementations. The support of other encodings is Oracle's extension. The oratext* data type is used for all encodings.
Table 2-1 summarizes the datatypes of the Dom package.
Table 2-1 Summary of Datatypes; Dom Package
| Datatype | Description |
|---|---|
|
|
Defines values returned by node filters. |
|
|
Defines type of comparison. |
|
|
Defines type of node. |
|
|
Defines codes for DOM exception. |
|
|
Defines codes for filtering. |
|
|
Codes for DOM Range exceptions. |
Defines values returned by node filters. Used by node iterators and tree walkers.
Definition
typedef enum AcceptNodeCode {
FILTER_ACCEPT = 1,
FILTER_REJECT = 2,
FILTER_SKIP = 3
} AcceptNodeCode;
Defines type of comparison.
Definition
typedef enum CompareHowCode {
START_TO_START = 0,
START_TO_END = 1,
END_TO_END = 2,
END_TO_START = 3 }
CompareHowCode;
Defines type of node.
Definition
typedef enum DOMNodeType {
UNDEFINED_NODE = 0,
ELEMENT_NODE = 1,
ATTRIBUTE_NODE = 2,
TEXT_NODE = 3,
CDATA_SECTION_NODE = 4,
ENTITY_REFERENCE_NODE = 5,
ENTITY_NODE = 6,
PROCESSING_INSTRUCTION_NODE = 7,
COMMENT_NODE = 8,
DOCUMENT_NODE = 9,
DOCUMENT_TYPE_NODE = 10,
DOCUMENT_FRAGMENT_NODE = 11,
NOTATION_NODE = 12
} DOMNodeType;
Defines codes for DOM exception.
Definition
typedef enum DOMExceptionCode {
UNDEFINED_ERR = 0,
INDEX_SIZE_ERR = 1,
DOMSTRING_SIZE_ERR = 2,
HIERARCHY_REQUEST_ERR = 3,
WRONG_DOCUMENT_ERR = 4,
INVALID_CHARACTER_ERR = 5,
NO_DATA_ALLOWED_ERR = 6,
NO_MODIFICATION_ALLOWED_ERR = 7,
NOT_FOUND_ERR = 8,
NOT_SUPPORTED_ERR = 9,
INUSE_ATTRIBUTE_ERR = 10,
INVALID_STATE_ERR = 11,
SYNTAX_ERR = 12,
INVALID_MODIFICATION_ERR = 13,
NAMESPACE_ERR = 14,
INVALID_ACCESS_ERR = 15
} DOMExceptionCode;
Defines codes for filtering.
Definition
typedef unsigned long WhatToShowCode; const unsigned long SHOW_ALL = 0xFFFFFFFF; c onst unsigned long SHOW_ELEMENT = 0x00000001; const unsigned long SHOW_ATTRIBUTE = 0x00000002; const unsigned long SHOW_TEXT = 0x00000004; const unsigned long SHOW_CDATA_SECTION = 0x00000008; const unsigned long SHOW_ENTITY_REFERENCE = 0x00000010; const unsigned long SHOW_ENTITY = 0x00000020; const unsigned long SHOW_PROCESSING_INSTRUCTION = 0x00000040; const unsigned long SHOW_COMMENT = 0x00000080; const unsigned long SHOW_DOCUMENT = 0x00000100; const unsigned long SHOW_DOCUMENT_TYPE = 0x00000200; const unsigned long SHOW_DOCUMENT_FRAGMENT = 0x00000400; const unsigned long SHOW_NOTATION = 0x00000800;
Codes for DOM Range exceptions.
Definition
typedef enum RangeExceptionCode {
RANGE_UNDEFINED_ERR = 0,
BAD_BOUNDARYPOINTS_ERR = 1,
INVALID_NODE_TYPE_ERR = 2
} RangeExceptionCode;
Table 2-2 summarizes the methods available through AttrRef interface.
Table 2-2 Summary of AttrRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Return attribute's name. |
|
|
Return attribute's owning element. |
|
|
Return boolean indicating if an attribute was explicitly created. |
|
|
Return attribute's value. |
|
|
Set attribute's value. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
AttrRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given attribute node after a call to createAttribute. |
AttrRef( const AttrRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(AttrRef) Node reference object
Returns the fully-qualified name of an attribute (in the data encoding) as a NULL-terminated string.
Syntax
oratext* getName() const;
Returns
(oratext *) name of attribute
Returns attribute's owning element
Syntax
Node* getOwnerElement();
Returns
(Node*) attribute's owning element node.
Returns the 'specified' value for an attribute. If the attribute was explicitly given a value in the original document, it is TRUE; otherwise, it is FALSE. If the node is not an attribute, returns FALSE. If the user sets attribute's value through DOM, its 'specified' value will be TRUE.
Syntax
boolean getSpecified() const;
Returns
(boolean) attribute's "specified" value
Returns the "value" (character data) of an attribute (in the data encoding) as NULL-terminated string. Character and general entities will have been replaced.
Syntax
oratext* getValue() const;
Returns
(oratext*) attribute's value
Sets the given attribute's value to data. The new value must be in the data encoding. It is not verified, converted, or checked. The attribute's 'specified' flag will be TRUE after setting a new value.
Syntax
void setValue( oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
data | new value of attribute |
This is the default destructor.
Syntax
~AttrRef();
Table 2-3 summarizes the methods available through CDATASectionRef interface.
Table 2-3 Summary of CDATASectionRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
CDATASectionRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given CDATA node after a call to createCDATASection. |
CDATASectionRef( const CDATASectionRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(CDATASectionRef) Node reference object
This is the default destructor.
Syntax
~CDATASectionRef();
Table 2-4 summarizes the methods available through CharacterDataRef interface.
Table 2-4 Summary of CharacterDataRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Append data to end of node's current data. |
|
|
Remove part of node's data. |
|
|
Deallocate the string allocated by |
|
|
Return node's data. |
|
|
Return length of node's data. |
|
|
Insert string into node's current data. |
|
|
Replace part of node's data. |
|
|
Set node's data. |
|
|
Get substring of node's data. |
Append a string to the end of a CharacterData node's data. The appended data should be in the data encoding. It will not be verified, converted, or checked.
Syntax
void appendData( oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
data | data to append |
Remove a range of characters from a CharacterData node's data. The offset is zero-based, so offset zero refers to the start of the data. Both offset and count are in characters, not bytes. If the sum of offset and count exceeds the data length then all characters from offset to the end of the data are deleted.
Syntax
void deleteData( ub4 offset, ub4 count) throw (DOMException);
| Parameter | Description |
|---|---|
offset | character offset where deletion starts |
count | number of characters to delete |
Deallocates the string allocated by substringData(). It is Oracle's extension.
Syntax
void freeString( oratext* str);
| Parameter | Description |
|---|---|
str | string |
Returns the data for a CharacterData node (type text, comment or CDATA) in the data encoding.
Syntax
oratext* getData() const;
Returns
(oratext*) node's data
Returns the length of the data for a CharacterData node (type Text, Comment or CDATA) in characters (not bytes).
Syntax
ub4 getLength() const;
Returns
(ub4) length in characters (not bytes!) of node's data
Insert a string into a CharacterData node's data at the specified position. The inserted data must be in the data encoding. It will not be verified, converted, or checked. The offset is specified as characters, not bytes. The offset is zero-based, so inserting at offset zero prepends the data.
Syntax
void insertData( ub4 offset, oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
offset | character offset where insertion starts |
data | data to insert |
Replaces a range of characters in a CharacterData node's data with a new string. The offset is zero-based, so offset zero refers to the start of the data. The replacement data must be in the data encoding. It will not be verified, converted, or checked. The offset and count are both in characters, not bytes. If the sum of offset and count exceeds length, then all characters to the end of the data are replaced.
Syntax
void replaceData( ub4 offset, ub4 count, oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
offset | offset |
count | number of characters to replace |
data | data |
Sets data for a CharacterData node (type text, comment or CDATA), replacing the old data. The new data is not verified, converted, or checked -- it should be in the data encoding.
Syntax
void setData( oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
data | data |
Returns a range of character data from a CharacterData node (type Text, Comment or CDATA). Since the data is in the data encoding, offset and count are in characters, not bytes. The beginning of the string is offset 0. If the sum of offset and count exceeds the length, then all characters to the end of the data are returned. The substring is permanently allocated in the context managed memory and should be explicitly deallocated by freeString
Syntax
oratext* substringData( ub4 offset, ub4 count) throw (DOMException);
| Parameter | Description |
|---|---|
offset | offset |
count | number of characters to extract |
Returns
(oratext *) specified substring
Table 2-5 summarizes the methods available through CommentRef interface.
Table 2-5 Summary of CommentRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
CommentRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given comment node after a call to createComment. |
CommentRef( const CommentRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(CommentRef) Node reference object
This is the default destructor.
Syntax
~CommentRef();
Table 2-6 summarizes the methods available through the DOMException interface.
Table 2-6 Summary of DOMException Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Get DOM exception code embedded in the exception. |
|
|
Get current language encoding of error messages. |
|
|
Get Oracle XML error message. |
This is a virtual member function that defines a prototype for implementation defined member functions returning DOM exception codes, defined in DOMExceptionCode, of the exceptional situations during execution
Syntax
virtual DOMExceptionCode getDOMCode() const = 0;
Returns
(DOMExceptionCode) exception code
Virtual member function inherited from XmlException
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext*) Current language (encoding) of error messages
Virtual member function inherited from XmlException
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
Table 2-7 summarizes the methods available through DOMImplRef interface.
Table 2-7 Summary of DOMImplRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Create document reference. |
|
|
Create DTD reference. |
|
|
Forms document reference given a document pointer. |
|
|
Get |
|
|
Get the 'no modification allowed' flag value. |
|
|
Determine if DOM feature is implemented. |
|
|
Set another context to a node. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
DOMImplRef( Context* ctx_ptr, DOMImplementation< Node>* impl_ptr); | Creates reference object to DOMImplementation object in a given context. Returns reference to the implementation object. |
DOMImplRef( const DOMImplRef< Context, Node>& iref); | It is needed to create other references to the implementation object; deletion flags are not copied. |
DOMImplRef( const DOMImplRef< Context, Node>& iref, Context* ctx_ptr); | It is needed to create references to the implementation object in a different context; deletion flags are not copied. |
| Parameter | Description |
|---|---|
ctx_ptr | context pointer |
impl_ptr | implementation |
Returns
(DOMImplRef) reference to the implementation object
Creates document reference
Syntax
DocumentRef< Node>* createDocument( oratext* namespaceURI, oratext* qualifiedName, DocumentTypeRef< Node>& doctype) throw (DOMException);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI of root element |
qualifiedName | qualified name of root element |
doctype | associated DTD node |
Returns
(DocumentRef< Node>*) document reference
Creates DTD reference
Syntax
DocumentTypeRef< Node>* createDocumentType( oratext* qualifiedName, oratext* publicId, oratext* systemId) throw (DOMException);
| Parameter | Description |
|---|---|
qualifiedName | qualified name |
publicId | external subset public Id |
systemId | external subset system Id |
Returns
(DocumentTypeRef< Node>*) DTD reference
Forms a document reference given a document pointer.
Syntax
DocumentRef< Node>* formDocument( Node* node);
| Parameter | Description |
|---|---|
node | pointer to the document node |
Returns
(DocumentRef< Node>*) pointer to the document reference
Returns DOMImplementation object that was used to create this document. When the DOMImplementation object is destructed, all document trees associated with it are also destructed.
Syntax
DOMImplementation< Node>* getImplementation() const;
Returns
(DOMImplementation) DOMImplementation reference object
Get the 'no modification allowed' flag value. This is an Oracle extension.
Syntax
boolean getNoMod() const;
Returns
TRUE if flag's value is TRUE, FALSE otherwise
Determine if a DOM feature is implemented. Returns TRUE if the feature is implemented in the specified version, FALSE otherwise.
In level 1, the legal values for package are 'HTML' and 'XML' (case-insensitive), and the version is the string "1.0". If the version is not specified, supporting any version of the feature will cause the method to return TRUE.
DOM 1.0 features are "XML" and "HTML".
DOM 2.0 features are "Core", "XML", "HTML", "Views", "StyleSheets", "CSS", "CSS2", "Events", "UIEvents", "MouseEvents", "MutationEvents", "HTMLEvents", "Range", "Traversal"
Syntax
boolean hasFeature( oratext* feature, oratext* version);
| Parameter | Description |
|---|---|
feature | package name of feature |
version | version of package |
Returns
(boolean) is feature implemented?
It is needed to create node references in a different context
Syntax
void setContext( NodeRef< Node>& nref, Context* ctx_ptr);
| Parameter | Description |
|---|---|
nref | reference node |
ctx_ptr | context pointer |
This is the default destructor. It cleans the reference to the implementation object. It is usually called by the environment. But it can be called by the user directly if necessary.
Syntax
~DOMImplRef();
Table 2-8 summarizes the methods available through DOMImplementation interface.
Table 2-8 Summary of DOMImplementation Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Get the 'nomodificationallowed' flag value. |
|
|
Public default destructor. |
Creates DOMImplementation object. Sets the 'no modifications allowed' flag to the parameter value.
Syntax
DOMImplementation( boolean no_mod);
| Parameter | Description |
|---|---|
no_mod | whether modifications are allowed (FALSE) or not allowed (TRUE) |
Returns
(DOMImplementation) implementation object
Get the 'no modification allowed' flag value. This is an Oracle extension.
Syntax
boolean getNoMod() const;
Returns
TRUE if flag's value is TRUE, FALSE otherwise
This is the default destructor. It removes all DOM trees associated with this object.
Syntax
~DOMImplementation();
Table 2-9 summarizes the methods available through DocumentFragmentRef interface.
Table 2-9 Summary of DocumentFragmentRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
DocumentFragmentRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given fragment node after a call to createDocumentFragment. |
DocumentFragmentRef( const DocumentFragmentRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(DocumentFragmentRef) Node reference object
This is the default destructor.
Syntax
~DocumentFragmentRef() {}
Table 2-10 summarizes the methods available through DocumentRange interface.
Table 2-10 Summary of DocumentRange Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Create new range object. |
|
|
Destroys Range object. |
|
|
Default destructor. |
Constructs the factory.
Syntax
DocumentRange();
Returns
(DocumentRange) new factory object
Create new range object.
Syntax
Range< Node>* createRange( DocumentRef< Node>& doc);
| Parameter | Description |
|---|---|
doc | reference to document node |
Returns
(Range*) Pointer to new range
Destroys range object.
Syntax
void destroyRange( Range< Node>* range) throw (DOMException);
| Parameter | Description |
|---|---|
range | range |
Default destructor.
Syntax
~DocumentRange();
Table 2-11 summarizes the methods available through DocumentRef interface.
Table 2-11 Summary of DocumentRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Create an attribute node. |
|
|
Create an attribute node with namespace information. |
|
|
Create a CDATA node. |
|
|
Create a comment node. |
|
|
Create a document fragment. |
|
|
Create an element node. |
|
|
Create an element node with names pace information. |
|
|
Create an entity reference node. |
|
|
Create a |
|
|
Create a text node. |
|
|
Get DTD associated with the document. |
|
|
Get top-level element of this document. |
|
|
Get an element given its ID. |
|
|
Get elements in the document by tag name. |
|
|
Get elements in the document by tag name (namespace aware version). |
|
|
Get |
|
|
Import a node from another DOM.s |
|
|
Public default destructor. |
This is a constructor.
| Syntax | Description |
|---|---|
DocumentRef( const NodeRef< Node>& nref, Node* nptr); | Default constructor. |
DocumentRef( const DocumentRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
nref | reference to provide the context |
nptr | referenced node |
Returns
(DocumentRef) Node reference object
Creates an attribute node with the given name. This is the non-namespace aware function. The new attribute will have NULL namespace URI and prefix, and its local name will be the same as its name, even if the name specified is a qualified name. The new node is an orphan with no parent. The name is not copied, its pointer is just stored. The user is responsible for persistence and freeing of that data.
Syntax
Node* createAttribute( oratext* name) throw (DOMException);
| Parameter | Description |
|---|---|
name | name |
Returns
(Node*) New attribute node
Creates an attribute node with the given namespace URI and qualified name. The new node is an orphan with no parent. The URI and qualified name are not copied, their pointers are just stored. The user is responsible for persistence and freeing of that data.
Syntax
Node* createAttributeNS( oratext* namespaceURI, oratext* qualifiedName) throw (DOMException);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI |
qualifiedName | qualified name |
Returns
(Node*) New attribute node
Creates a CDATA section node with the given initial data (which should be in the data encoding). A CDATA section is considered verbatim and is never parsed; it will not be joined with adjacent text nodes by the normalize operation. The initial data may be NULL, if provided; it is not verified, converted, or checked. The name of a CDATA node is always "#cdata-section". The new node is an orphan with no parent. The CDATA is not copied, its pointer is just stored. The user is responsible for persistence and freeing of that data.
Syntax
Node* createCDATASection( oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
data | data for new node |
Returns
(Node*) New CDATA node
Creates a comment node with the given initial data (which must be in the data encoding). The data may be NULL, if provided; it is not verified, converted, or checked. The name of the comment node is always "#comment". The new node is an orphan with no parent. The comment data is not copied, its pointer is just stored. The user is responsible for persistence and freeing of that data.
Syntax
Node* createComment( oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
data | data for new node |
Returns
(Node*) New comment node
Creates an empty Document Fragment node. A document fragment is treated specially when it is inserted into a DOM tree: the children of the fragment are inserted in order instead of the fragment node itself. After insertion, the fragment node will still exist, but have no children. The name of a fragment node is always "#document-fragment".
Syntax
Node* createDocumentFragment() throw (DOMException);
Returns
(Node*) new document fragment node
Creates an element node with the given tag name (which should be in the data encoding). The new node is an orphan with no parent. The tagname is not copied, its pointer is just stored. The user is responsible for persistence and freeing of that data.
Note that the tag name of an element is case sensitive. This is the non-namespace aware function: the new node will have NULL namespace URI and prefix, and its local name will be the same as its tag name, even if the tag name specified is a qualified name.
Syntax
Node* createElement( oratext* tagname) throw (DOMException);
| Parameter | Description |
|---|---|
tagname | tag name |
Returns
(Node*) New element node
Creates an element with the given namespace URI and qualified name. The new node is an orphan with no parent. The URI and qualified name are not copied, their pointers are just stored. The user is responsible for persistence and freeing of that data.
Note that element names are case sensitive, and the qualified name is required though the URI may be NULL. The qualified name will be split into prefix and local parts. The tagName will be the full qualified name.
Syntax
Node* createElementNS( oratext* namespaceURI, oratext* qualifiedName) throw (DOMException);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI |
qualifiedName | qualified name |
Returns
(Node*) New element node
Creates an entity reference node; the name (which should be in the data encoding) is the name of the entity to be referenced. The named entity does not have to exist. The name is not verified, converted, or checked. The new node is an orphan with no parent. The entity reference name is not copied; its pointer is just stored. The user is responsible for persistence and freeing of that data.
Note that entity reference nodes are never generated by the parser; instead, entity references are expanded as encountered. On output, an entity reference node will turn into a "&name;" style reference.
Syntax
Node* createEntityReference( oratext* name) throw (DOMException);
| Parameter | Description |
|---|---|
name | name |
Returns
(Node*) New entity reference node
Creates a processing instruction node with the given target and data (which should be in the data encoding). The data may be NULL, but the target is required and cannot be changed. The target and data are not verified, converted, or checked. The name of the node is the same as the target. The new node is an orphan with no parent. The target and data are not copied; their pointers are just stored. The user is responsible for persistence and freeing of that data.
Syntax
Node* createProcessingInstruction( oratext* target, oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
target | target |
data | data for new node |
Returns
(Node*) New PI node
Creates a text node with the given initial data (which must be non-NULL and in the data encoding). The data may be NULL; if provided, it is not verified, converted, checked, or parsed (entities will not be expanded). The name of the node is always "#text". The new node is an orphan with no parent. The text data is not copied, its pointer is just stored. The user is responsible for persistence and freeing of that data.
Syntax
Node* createTextNode( oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
data | data for new text node |
Returns
(Node*) new text node
Returns the DTD node associated with this document. After this call, a DocumentTypeRef object needs to be created with an appropriate constructor in order to call its member functions. The DTD tree cannot be edited.
Syntax
Node* getDoctype() const;
Returns
(Node*) DTD node
Returns the root element (node) of the DOM tree. Each document has only one uppermost Element node, called the root element. If there is no root element, NULL is returned. This can happen when the document tree is being constructed.
Syntax
Node* getDocumentElement() const;
Returns
(Node*) Root element
Returns the element node which has the given ID. Throws NOT_FOUND_ERR if no element is found. The given ID should be in the data encoding or it might not match.
Note that attributes named "ID" are not automatically of type ID; ID attributes (which can have any name) must be declared as type ID in the DTD or XML schema associated with the document.
Syntax
Node* getElementById( oratext* elementId);
| Parameter | Description |
|---|---|
elementId | element id |
Returns
(Node*)Element node
Returns a list of all elements in the document with a given tag name, in document order (the order in which they would be encountered in a preorder traversal of the tree). The list should be freed by the user when it is no longer needed. The list is not live, it is a snapshot. That is, if a new node which matched the tag name were added to the DOM after the list was returned, the list would not automatically be updated to include the node.
The special name "*" matches all tag names; a NULL name matches nothing. Note that tag names are case sensitive, and should be in the data encoding or a mismatch might occur.
This function is not namespace aware; the full tag names are compared. If two qualified names with two different prefixes both of which map to the same URI are compared, the comparison will fail.
Syntax
NodeList< Node>* getElementsByTagName( oratext* tagname) const;
| Parameter | Description |
|---|---|
tagname | tag name |
Returns
(NodeList< Node>*) List of nodes
Returns a list of all elements in the document with a given namespace URI and local name, in document order (the order in which they would be encountered in a preorder traversal of the tree). The list should be freed by the user when it is no longer needed. The list is not live, it is a snapshot. That is, if a new node which matches the URI and local name were added to the DOM after the list was returned, the list would not automatically be updated to include the node.
The URI and local name should be in the data encoding. The special name "*" matches all local names; a NULL local name matches nothing. Namespace URIs must always match, however, no wildcard is allowed. Note that comparisons are case sensitive.
Syntax
NodeList< Node>* getElementsByTagNameNS( oratext* namespaceURI, oratext* localName);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI to match |
localName | local name to match |
Returns
(NodeList< Node>*) List of nodes
Returns DOMImplementation object that was used to create this document. When the DOMImplementation object is destructed, all document trees associated with it are also destructed.
Syntax
DOMImplementation< Node>* getImplementation() const;
Returns
(DOMImplementation) DOMImplementation reference object
Imports a node from one Document to another. The new node is an orphan and has no parent. The original node is not modified in any way or removed from its document; instead, a new node is created with copies of all the original node's qualified name, prefix, namespace URI, and local name.
The deep parameter controls whether the children of the node are recursively imported. If FALSE, only the node itself is imported, and it will have no children. If TRUE, all descendents of the node will be imported as well, and an entire new subtree created. Elements will have only their specified attributes imported; non-specified (default) attributes are omitted. New default attributes (for the destination document) are then added. Document and DocumentType nodes cannot be imported.
Syntax
Node* importNode( NodeRef< Node>& importedNode, boolean deep) const throw (DOMException);
| Parameter | Description |
|---|---|
importedNode | node to import |
deep | indicator for recursively importing the subtree |
Returns
(Node*) New imported node
This is the default destructor. It cleans the reference to the node. If the document node is marked for deletion, the destructor deletes the node and the tree under it. It is always deep deletion in the case of a document node. The destructor can be called by the environment or by the user directly.
Syntax
~DocumentRef();
Table 2-12 summarizes the methods available through DocumentTraversal interface.
Table 2-12 Summary of DocumentTraversal Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Create new |
|
|
Create new |
|
|
Destroys |
|
|
Destroys |
|
|
Default destructor. |
Constructs the factory.
Syntax
DocumentTraversal();
Returns
(DocumentTraversal) new factory object
Create new iterator object.
Syntax
NodeIterator< Node>* createNodeIterator( NodeRef< Node>& root, WhatToShowCode whatToShow, boolean entityReferenceExpansion) throw (DOMException);
| Parameter | Description |
|---|---|
root | root of subtree, for iteration |
whatToShow | node types filter |
entityReferenceExpansion | if TRUE, expand entity references |
Returns
(NodeIterator*) Pointer to new iterator
Create new TreeWalker object.
Syntax
TreeWalker< Node>* createTreeWalker( NodeRef< Node>& root, WhatToShowCode whatToShow, boolean entityReferenceExpansion) throw (DOMException);
| Parameter | Description |
|---|---|
root | root of subtree, for traversal |
whatToShow | node types filter |
entityReferenceExpansion | if TRUE, expand entity references |
Returns
(TreeWalker*) Pointer to new tree walker
Destroys node iterator object.
Syntax
void destroyNodeIterator( NodeIterator< Node>* iter) throw (DOMException);
| Parameter | Description |
|---|---|
iter | iterator |
Destroys TreeWalker object.
Syntax
void destroyTreeWalker( TreeWalker< Node>* walker) throw (DOMException);
| Parameter | Description |
|---|---|
walker | TreeWalker |
Default destructor.
Syntax
~DocumentTraversal();
Table 2-13 summarizes the methods available through DocumentTypeRef interface.
Table 2-13 Summary of DocumentTypeRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Get DTD's entities. |
|
|
Get DTD's internal subset. |
|
|
Get name of DTD. |
|
|
Get DTD's notations. |
|
|
Get DTD's public ID. |
|
|
Get DTD's system ID. |
|
|
Public default destructor. |
This is a constructor.
| Syntax | Description |
|---|---|
DocumentTypeRef( const NodeRef< Node>& node_ref, Node* nptr); | Default constructor. |
DocumentTypeRef( const DocumentTypeRef< Node>& node_ref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(DocumentTypeRef) Node reference object
Returns a named node map of general entities defined by the DTD.
Syntax
NamedNodeMap< Node>* getEntities() const;
Returns
(NamedNodeMap< Node>*) map containing entities
Returns the content model for an element. If there is no DTD, returns NULL.
Syntax
Node* getInternalSubset( oratext* name);
| Parameter | Description |
|---|---|
name | name of element |
Returns
(xmlnode*) content model subtree
Returns DTD's name (specified immediately after the DOCTYPE keyword)
Syntax
oratext* getName() const;
Returns
(oratext*) name of DTD
Returns a named node map of notations declared by the DTD.
Syntax
NamedNodeMap< Node>* getNotations() const;
Returns
(NamedNodeMap< Node>*) map containing notations
Returns DTD's public identifier
Syntax
oratext* getPublicId() const;
Returns
(oratext*) DTD's public identifier
Returns DTD's system identifier
Syntax
oratext* getSystemId() const;
Returns
(oratext*) DTD's system identifier
This is the default destructor.
Syntax
~DocumentTypeRef();
Table 2-14 summarizes the methods available through ElementRef interface.
Table 2-14 Summary of ElementRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Get attribute's value given its name. |
|
|
Get attribute's value given its URI and local name. |
|
|
Get the attribute node given its name. |
|
|
Get elements with given tag name. |
|
|
Get element's tag name. |
|
|
Check if named attribute exists. |
|
|
Check if named attribute exists (namespace aware version). |
|
|
Remove attribute with specified name. |
|
|
Remove attribute with specified URI and local name. |
|
|
Remove attribute node |
|
|
Set new attribute for this element and/or new value. |
|
|
Set new attribute for the element and/or new value. |
|
|
Set attribute node. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
ElementRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given element node after a call to createElement. |
ElementRef( const ElementRef< Node>& node_ref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(ElementRef) Node reference object
Returns the value of an element's attribute (specified by name). Note that an attribute may have the empty string as its value, but cannot be NULL.
Syntax
oratext* getAttribute( oratext* name) const;
| Parameter | Description |
|---|---|
name | name of attribute (data encoding) |
Returns
(oratext*) named attribute's value (in data encoding)
Returns the value of an element's attribute (specified by URI and local name). Note that an attribute may have the empty string as its value, but cannot be NULL.
Syntax
oratext* getAttributeNS( oratext* namespaceURI, oratext* localName);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI of attribute (data encoding) |
localName | local name of attribute (data encoding) |
Returns
(oratext *) named attribute's value (in data encoding)
Returns the attribute node given its name.
Syntax
Node* getAttributeNode( oratext* name) const;
| Parameter | Description |
|---|---|
name | name of attribute (data encoding) |
Returns
(Node*) the attribute node
Returns a list of all elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the subtree. The tag name should be in the data encoding. The special name "*" matches all tag names; a NULL name matches nothing. Tag names are case sensitive. This function is not namespace aware; the full tag names are compared. The returned list should be freed by the user.
Syntax
NodeList< Node>* getElementsByTagName( oratext* name);
| Parameter | Description |
|---|---|
name | tag name to match (data encoding) |
Returns
(NodeList< Node>*) the list of elements
Returns the tag name of an element node which is supposed to have the same value as the node name from the node interface
Syntax
oratext* getTagName() const;
Returns
(oratext*) element's name [in data encoding]
Determines if an element has a attribute with the given name
Syntax
boolean hasAttribute( oratext* name);
| Parameter | Description |
|---|---|
name | name of attribute (data encoding) |
Returns
(boolean) TRUE if element has attribute with given name
Determines if an element has a attribute with the given URI and local name
Syntax
boolean hasAttributeNS( oratext* namespaceURI, oratext* localName);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI of attribute (data encoding) |
localName | local name of attribute (data encoding) |
Returns
(boolean) TRUE if element has such attribute
Removes an attribute specified by name. The attribute is removed from the element's list of attributes, but the attribute node itself is not destroyed.
Syntax
void removeAttribute( oratext* name) throw (DOMException);
| Parameter | Description |
|---|---|
name | name of attribute (data encoding) |
Removes an attribute specified by URI and local name. The attribute is removed from the element's list of attributes, but the attribute node itself is not destroyed.
Syntax
void removeAttributeNS( oratext* namespaceURI, oratext* localName) throw (DOMException);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI of attribute (data encoding) |
localName | local name of attribute (data encoding) |
Removes an attribute from an element. Returns a pointer to the removed attribute or NULL
Syntax
Node* removeAttributeNode( AttrRef< Node>& oldAttr) throw (DOMException);
| Parameter | Description |
|---|---|
oldAttr | old attribute node |
Returns
(Node*) the attribute node (old) or NULL
Creates a new attribute for an element with the given name and value (which should be in the data encoding). If the named attribute already exists, its value is simply replaced. The name and value are not verified, converted, or checked. The value is not parsed, so entity references will not be expanded.
Syntax
void setAttribute( oratext* name, oratext* value) throw (DOMException);
| Parameter | Description |
|---|---|
name | names of attribute (data encoding) |
value | value of attribute (data encoding) |
Creates a new attribute for an element with the given URI, local name and value (which should be in the data encoding). If the named attribute already exists, its value is simply replaced. The name and value are not verified, converted, or checked. The value is not parsed, so entity references will not be expanded.
Syntax
void setAttributeNS( oratext* namespaceURI, oratext* qualifiedName, oratext* value) throw (DOMException);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI of attribute (data encoding) |
qualifiedName | qualified name of attribute(data encoding) |
value | value of attribute(data encoding) |
Adds a new attribute to an element. If an attribute with the given name already exists, it is replaced and a pointer to the old attribute returned. If the attribute is new, it is added to the element's list and a pointer to the new attribute is returned.
Syntax
Node* setAttributeNode( AttrRef< Node>& newAttr) throw (DOMException);
| Parameter | Description |
|---|---|
newAttr | new node |
Returns
(Node*) the attribute node (old or new)
This is the default destructor.
Syntax
~ElementRef();
Table 2-15 summarizes the methods available through EntityRef interface.
Table 2-15 Summary of EntityRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Get entity's notation. |
|
|
Get entity's public ID. |
|
|
Get entity's system ID. |
|
|
Get entity's type. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
EntityRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given entity node after a call to create Entity. |
EntityRef( const EntityRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(EntityRef) Node reference object
For unparsed entities, returns the name of its notation (in the data encoding). For parsed entities and other node types, returns NULL.
Syntax
oratext* getNotationName() const;
Returns
(oratext*) entity's notation
Returns an entity's public identifier (in the data encoding).
Syntax
oratext* getPublicId() const;
Returns
(oratext*) entity's public identifier
Returns an entity's system identifier (in the data encoding).
Syntax
oratext* getSystemId() const;
Returns
(oratext*) entity's system identifier
Returns a boolean for an entity describing whether it is general (TRUE) or parameter (FALSE).
Syntax
boolean getType() const;
Returns
(boolean) TRUE for general entity, FALSE for parameter entity
This is the default destructor.
Syntax
~EntityRef();
Table 2-16 summarizes the methods available through EntityReferenceRef interface.
Table 2-16 Summary of EntityReferenceRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
EntityReferenceRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given entity reference node after a call to create EntityReference. |
EntityReferenceRef( const EntityReferenceRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(EntityReferenceRef) Node reference object
This is the default destructor.
Syntax
~EntityReferenceRef();
Table 2-17 summarizes the methods available through NamedNodeMapRef interface.
Table 2-17 Summary of NamedNodeMapRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor |
|
|
Get map's length |
|
|
Get item given its name |
|
|
Get item given its namespace URI and local name. |
|
|
Get item given its index. |
|
|
Remove an item given its name. |
|
|
Remove the item from the map. |
|
|
Add new item to the map. |
|
|
Set named item to the map. |
|
|
Default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
NamedNodeMapRef( const NodeRef< Node>& node_ref, NamedNodeMap< Node>* mptr); | Used to create references to a given NamedNodeMap node. |
NamedNodeMapRef( const NamedNodeMapRef< Node>& mref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(NamedNodeMapRef) Node reference object
Get the length of the map.
Syntax
ub4 getLength() const;
Returns
(ub4) map's length
Get the name of the item, given its name.
Syntax
Node* getNamedItem( oratext* name) const;
| Parameter | Description |
|---|---|
name | name of item |
Returns
(Node*) pointer to the item
Get the name of the item, given its namespace URI and local name.
Syntax
Node* getNamedItemNS( oratext* namespaceURI, oratext* localName) const;
| Parameter | Description |
|---|---|
namespaceURI | namespace URI of item |
localName | local name of item |
Returns
(Node*) pointer to the item
Get item, given its index.
Syntax
Node* item( ub4 index) const;
| Parameter | Description |
|---|---|
index | index of item |
Returns
(Node*) pointer to the item
Remove the item from the map, given its name.
Syntax
Node* removeNamedItem( oratext* name) throw (DOMException);
| Parameter | Description |
|---|---|
name | name of item |
Returns
(Node*) pointer to the removed item
Remove the item from the map, given its namespace URI and local name.
Syntax
Node* removeNamedItemNS( oratext* namespaceURI, oratext* localName) throw (DOMException);
| Parameter | Description |
|---|---|
namespaceURI | namespace URI of item |
localName | local name of item |
Returns
(Node*) pointer to the removed item
Add new item to the map.
Syntax
Node* setNamedItem( NodeRef< Node>& newItem) throw (DOMException);
| Parameter | Description |
|---|---|
newItem | item set to the map |
Returns
(Node*) pointer to new item
Set named item, which is namespace aware, to the map.
Syntax
Node* setNamedItemNS( NodeRef< Node>& newItem) throw (DOMException);
| Parameter | Description |
|---|---|
newItem | item set to the map |
Returns
(Node*) pointer to the item
Default destructor.
Syntax
~NamedNodeMapRef();
Table 2-18 summarizes the methods available through NodeFilter interface.
Table 2-18 Summary of NodeFilter Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Execute it for a given node and use its return value. |
This function is used as a test by NodeIt erator and TreeWalker.
Syntax
template< typename Node> AcceptNodeCode AcceptNode( NodeRef< Node>& nref);
| Parameter | Description |
|---|---|
nref | reference to the node to be tested. |
Returns
(AcceptNodeCode) result returned by the filter function
Table 2-19 summarizes the methods available through NodeIterator interface.
Table 2-19 Summary of NodeIterator Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Attach this iterator to the another context. |
|
|
Invalidate the iterator. |
|
|
Go to the next node. |
|
|
Go to the previous node. |
Attaches this iterator to the context associated with a given node reference
Syntax
void adjustCtx( NodeRef< Node>& nref);
| Parameter | Description |
|---|---|
nref | reference node |
Invalidates the iterator.
Syntax
void detach();
Go to the next node.
Syntax
Node* nextNode() throw (DOMException);
Returns
(Node*) pointer to the next node
Go to the previous node.
Syntax
Node* previousNode() throw (DOMException);
Returns
(Node*) pointer to the previous node
Table 2-20 summarizes the methods available through NodeListRef interface.
Table 2-20 Summary of NodeListRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Get list's length. |
|
|
Get item given its index. |
|
|
Default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
NodeListRef( const NodeRef< Node>& node_ref, NodeList< Node>* lptr); | Used to create references to a given NodeList node. |
NodeListRef( const NodeListRef< Node>& lref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
lptr | referenced list |
Returns
(NodeListRef) Node reference object
Get the length of the list.
Syntax
ub4 getLength() const;
Returns
(ub4) list's length
Get the item, given its index.
Syntax
Node* item( ub4 index) const;
| Parameter | Description |
|---|---|
index | index of item |
Returns
(Node*) pointer to the item
Destructs the object.
Syntax
~NodeListRef();
Table 2-21 summarizes the methods available through NodeRef interface.
Table 2-21 Summary of NodeRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Append new child to node's list of children. |
|
|
Clone this node. |
|
|
Get attributes of this node. |
|
|
Get children of this node. |
|
|
Get the first child node of this node. |
|
|
Get the last child node of this node. |
|
|
Get local name of this node. |
|
|
Get namespace URI of this node as a |
|
|
Get the next sibling node of this node. |
|
|
Tests if no modifications are allowed for this node. |
|
|
Get node's name as |
|
|
Get DOMNodeType of the node. |
|
|
Get node's value as |
|
|
Get the owner document of this node. |
|
|
Get parent node of this node. |
|
|
Get namespace prefix of this node. |
|
|
Get the previous sibling node of this node. |
|
|
Tests if this node has attributes. |
|
|
Test if this node has children. |
|
|
Insert new child into node's list of children. |
|
|
Tests if specified feature is supported by the implementation. |
|
|
Sets the mark to delete the referenced node. |
|
|
Merge adjacent text nodes. |
|
|
Remove an existing child node. |
|
|
Replace an existing child of a node. |
|
|
Reset NodeRef to reference another node. |
|
|
Set node's value as |
|
|
Set namespace prefix of this node. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
NodeRef( const NodeRef< Node>& nref, Node* nptr); | Used to create references to a given node when at least one reference to this node or another node is already available. The node deletion flag is not copied and is set to FALSE. |
NodeRef( const NodeRef< Node>& nref); | Copy constructor. Used to create additional references to the node when at least one reference is already available. The node deletion flag is not copied and is set to FALSE. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(NodeRef) Node reference object
Appends the node to the end of this node's list of children and returns the new node. If newChild is a DocumentFragment, all of its children are appended in original order; the DocumentFragment node itself is not. If newChild is already in the DOM tree, it is first removed from its current position.
Syntax
Node* appendChild( NodeRef& newChild) throw (DOMException);
| Parameter | Description |
|---|---|
newChild | reference node |
Returns
(Node*) the node appended
Creates and returns a duplicate of this node. The duplicate node has no parent. Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but it does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning any other type of node simply returns a copy of the node. If deep is TRUE, all children of the node are recursively cloned, and the cloned node will have cloned children; a non-deep clone will have no children. If the cloned node is not inserted into another tree or fragment, it probably should be marked, through its reference, for deletion (by the user).
Syntax
Node* cloneNode( boolean deep);
| Parameter | Description |
|---|---|
deep | whether to clone the entire node hierarchy beneath the node (TRUE), or just the node itself (FALSE) |
Returns
(Node*) duplicate (cloned) node
Returns NamedNodeMap of attributes of this node, or NULL if it has no attributes. Only element nodes can have attribute nodes. For other node kinds, NULL is always returned. In the current implementation, the node map of child nodes is live; all changes in the original node are reflected immediately. Because of this, side effects can be present for some DOM tree manipulation styles, in particular, in multithreaded environments.
Syntax
NamedNodeMap< Node>* getAttributes() const;
Returns
(NamedNodeMap*) NamedNodeMap of attributes
Returns the list of child nodes, or NULL if this node has no children. Only Element, Document, DTD, and DocumentFragment nodes may have children; all other types will return NULL. In the current implementation, the list of child nodes is live; all changes in the original node are reflected immediately. Because of this, side effects can be present for some DOM tree manipulation styles, in particular, in multithreaded environments.
Syntax
NodeList< Node>* getChildNodes() const;
Returns
(NodeList*) the list of child nodes
Returns the first child node, or NULL, if this node has no children
Syntax
Node* getFirstChild() const;
Returns
(Node*) the first child node, or NULL
Returns the last child node, or NULL, if this node has no children
Syntax
Node* getLastChild() const;
Returns
(Node*) the last child node, or NULL
Returns local name (local part of the qualified name) of this node (in the data encoding) as a NULL-terminated string. If this node's name is not fully qualified (has no prefix), then the local name is the same as the name.
Syntax
oratext* getLocalName() const;
Returns
(oratext*) local name of this node
Returns the namespace URI of this node (in the data encoding) as a NULL-terminated string. If the node's name is not qualified (does not contain a namespace prefix), it will have the default namespace in effect when the node was created (which may be NULL).
Syntax
oratext* getNamespaceURI() const;
Returns
(oratext*) namespace URI of this node
Returns the next sibling node, or NULL, if this node has no next sibling
Syntax
Node* getNextSibling() const;
Returns
(Node*) the next sibling node, or NULL
Tests if no modifications are allowed for this node and the DOM tree it belongs to. This member function is Oracle extension.
Syntax
boolean getNoMod() const;
Returns
(boolean) TRUE if no modifications are allowed
Returns the (fully-qualified) name of the node (in the data encoding) as a NULL-terminated string, for example "bar\0" or "foo:bar\0". Some node kinds have fixed names: "#text", "#cdata-section", "#comment", "#document", "#document-fragment". The name of a node cannot changed once it is created.
Syntax
oratext* getNodeName() const;
Returns
(oratext*) name of node in data encoding
Returns DOMNodeType of the node
Syntax
DOMNodeType getNodeType() const;
Returns
(DOMNodeType) of the node
Returns the "value" (associated character data) for a node as a NULL-terminated string. Character and general entities will have been replaced. Only Attr, CDATA, Comment, ProcessingInstruction and Text nodes have values, all other node types have NULL value.
Syntax
oratext* getNodeValue() const;
Returns
(oratext *) value of node
Returns the document node associated with this node. It is assumed that the document node type is derived from the node type. Each node may belong to only one document, or may not be associated with any document at all, such as immediately after it was created on user's request. The "owning" document [node] is returned, or the WRONG_DOCUMENT_ERR exception is thrown.
Syntax
Node* getOwnerDocument() const throw (DOMException);
Returns
(Node*) the owning document node
Returns the parent node, or NULL, if this node has no parent
Syntax
Node* getParentNode() const;
Returns
(Node*) the parent node, or NULL
Returns the namespace prefix of this node (in the data encoding) (as a NULL-terminated string). If this node's name is not fully qualified (has no prefix), NULL is returned.
Syntax
oratext* getPrefix() const;
Returns
(oratext*) namespace prefix of this node
Returns the previous sibling node, or NULL, if this node has no previous siblings
Syntax
Node* getPreviousSibling() const;
Returns
(Node*) the previous sibling node, or NULL
Returns TRUE if this node has attributes, if it is an element. Otherwise, it returns FALSE. Note that for nodes that are not elements, it always returns FALSE.
Syntax
boolean hasAttributes() const;
Returns
(boolean) TRUE is this node is an element and has attributes
Tests if this node has children. Only Element, Document, DTD, and DocumentFragment nodes may have children.
Syntax
boolean hasChildNodes() const;
Returns
(boolean) TRUE if this node has any children
Inserts the node newChild before the existing child node refChild in this node. refChild must be a child of this node. If newChild is a DocumentFragment, all of its children are inserted (in the same order) before refChild; the DocumentFragment node itself is not. If newChild is already in the DOM tree, it is first removed from its current position.
Syntax
Node* insertBefore( NodeRef& newChild, NodeRef& refChild) throw (DOMException);
| Parameter | Description |
|---|---|
newChild | new node |
refChild | reference node |
Returns
(Node*) the node being inserted
Tests if the feature, specified by the arguments, is supported by the DOM implementation of this node.
Syntax
boolean isSupported( oratext* feature, oratext* version) const;
| Parameter | Description |
|---|---|
feature | package name of feature |
version | version of package |
Returns
(boolean) TRUE is specified feature is supported
Sets the mark indicating that the referenced node should be deleted at the time when destructor of this reference is called. All other references to the node become invalid. This behavior is inherited by all other reference classes. This member function is Oracle extension.
Syntax
void markToDelete();
"Normalizes" the subtree rooted at an element, merges adjacent Text nodes children of elements. Note that adjacent Text nodes will never be created during a normal parse, only after manipulation of the document with DOM calls.
Syntax
void normalize();
Removes the node from this node's list of children and returns it. The node is orphaned; its parent will be NULL after removal.
Syntax
Node* removeChild( NodeRef& oldChild) throw (DOMException);
| Parameter | Description |
|---|---|
oldChild | old node |
Returns
(Node*) node removed
Replaces the child node oldChild with the new node newChild in this node's children list, and returns oldChild (which is now orphaned, with a NULL parent). If newChild is a DocumentFragment, all of its children are inserted in place of oldChild; the DocumentFragment node itself is not. If newChild is already in the DOM tree, it is first removed from its current position.
Syntax
Node* replaceChild( NodeRef& newChild, NodeRef& oldChild) throw (DOMException);
| Parameter | Description |
|---|---|
newChild | new node |
oldChild | old node |
Returns
(Node*) the node replaced
This function resets NodeRef to reference Node given as an argument
Syntax
void resetNode( Node* nptr);
| Parameter | Description |
|---|---|
nptr | reference node |
Sets a node's value (character data) as a NULL-terminated string. Does not allow setting the value to NULL. Only Attr, CDATA, Comment, ProcessingInstruction, and Text nodes have values. Trying to set the value of another kind of node is a no-op. The new value must be in the data encoding! It is not verified, converted, or checked. The value is not copied, its pointer is just stored. The user is responsible for persistence and freeing of that data.
It throws the NO_MODIFICATION_ALLOWED_ERR exception, if no modifications are allowed, or UNDEFINED_ERR, with an appropriate Oracle XML error code (see xml.h), in the case of an implementation defined error.
Syntax
void setNodeValue( oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
data | new value for node |
Sets the namespace prefix of this node (as NULL-terminated string). Does not verify the prefix is defined! And does not verify that the prefix is in the current data encoding. Just causes a new qualified name to be formed from the new prefix and the old local name.
It throws the NO_MODIFICATION_ALLOWED_ERR exception, if no modifications are allowed. Or it throws NAMESPACE_ERR if the namespaceURI of this node is NULL, or if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", or if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/". Note that the INVALID_CHARACTER_ERR exception is never thrown since it is not checked how the prefix is formed
Syntax
void setPrefix( oratext* prefix) throw (DOMException);
| Parameter | Description |
|---|---|
prefix | new namespace prefix |
This is the default destructor. It cleans the reference to the node and, if the node is marked for deletion, deletes the node. If the node was marked for deep deletion, the tree under the node is also deleted (deallocated). It is usually called by the environment. But it can be called by the user directly if necessary.
Syntax
~NodeRef();
Table 2-22 summarizes the methods available through NotationRef interface.
Table 2-22 Summary of NotationRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Get public ID. |
|
|
Get system ID. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
NotationRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given notation node after a call to create Notation. |
NotationRef( const NotationRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(NotationRef) Node reference object
Get public id.
Syntax
oratext* getPublicId() const;
Returns
(oratext*) public ID
Get system id.
Syntax
oratext* getSystemId() const;
Returns
(oratext*) system ID
This is the default destructor.
Syntax
~NotationRef();
Table 2-23 summarizes the methods available through ProcessingInstructionRef interface.
Table 2-23 Summary of ProcessingInstructionRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Get processing instruction's data. |
|
|
Get processing instruction's target. |
|
|
Set processing instruction's data. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
ProcessingInstructionRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given ProcessingInstruction node after a call to create ProcessingInstruction. |
ProcessingInstructionRef( const ProcessingInstructionRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(ProcessingInstructionRef) Node reference object
Returns the content (data) of a processing instruction (in the data encoding). The content is the part from the first non-whitespace character after the target until the ending "?>".
Syntax
oratext* getData() const;
Returns
(oratext*) processing instruction's data
Returns a processing instruction's target string. The target is the first token following the markup that begins the ProcessingInstruction. All ProcessingInstructions must have a target, though the data part is optional.
Syntax
oratext* getTarget() const;
Returns
(oratext*) processing instruction's target
Sets processing instruction's data (content), which must be in the data encoding. It is not permitted to set the data to NULL. The new data is not verified, converted, or checked.
Syntax
void setData( oratext* data) throw (DOMException);
| Parameter | Description |
|---|---|
data | new data |
This is the default destructor.
Syntax
~ProcessingInstructionRef();
Table 2-24 summarizes the methods available through Range interface.
Table 2-24 Summary of Range Methods; Dom Package
| Function | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
Invalidate the range. |
|
| |
|
|
Check if the range is collapsed. |
|
|
Get the deepest common ancestor node. |
|
|
Get end container node. |
|
|
Get offset of the end point. |
|
|
Get start container node. |
|
|
Get offset of the start point. |
|
| |
|
| |
|
| |
|
|
Set end point. |
|
| |
|
| |
|
|
Set start point. |
|
| |
|
| |
|
| |
|
|
Compares boundary points.
Syntax
CompareHowCode compareBoundaryPoints( unsigned short how, Range< Node>* sourceRange) throw (DOMException);
| Parameter | Description |
|---|---|
how | how to compare |
sourceRange | range of comparison |
Returns
(CompareHowCode) result of comparison
Makes a clone of the node, including its children.
Syntax
Node* cloneContents() throw (DOMException);
Returns
(Node*) subtree cloned
Clones a range of nodes.
Syntax
Range< Node>* cloneRange();
Returns
(Range< Node>*) new cloned range
Deletes contents of the node.
Syntax
void deleteContents() throw (DOMException);
Invalidates the range. It is not recommended to use this method since it leaves the object in invalid state. The preferable way is to call the destructor.
Syntax
void detach();
Extract the node.
Syntax
Node* extractContents() throw (DOMException);
Returns
(Node*) subtree extracted
Checks if the range is collapsed.
Syntax
boolean getCollapsed() const;
Returns
(boolean) TRUE if the range is collapsed, FALSE otherwise
Get the deepest common ancestor of the node.
Syntax
Node* getCommonAncestorContainer() const;
Returns
(Node*) common ancestor node
Gets the container node.
Syntax
Node* getEndContainer() const;
Returns
(Node*) end container node
Get offset of the end point.
Syntax
long getEndOffset() const;
Returns
(long) offset
Get start container node.
Syntax
Node* getStartContainer() const;
Returns
(Node*) start container node
Get offset of the start point.
Syntax
long getStartOffset() const;
Returns
(long) offset
Inserts a node.
Syntax
void insertNode( NodeRef< Node>& newNode) throw (RangeException, DOMException);
| Parameter | Description |
|---|---|
newNode | inserted node |
Selects node content by its reference.
Syntax
void selectNodeContent( NodeRef< Node>& refNode) throw (RangeException);
| Parameter | Description |
|---|---|
refNode | reference node |
Selects a node.
Syntax
void selectNode( NodeRef< Node>& refNode) throw (RangeException);
| Parameter | Description |
|---|---|
refNode | reference node |
Sets an end point.
Syntax
void setEnd( NodeRef< Node>& refNode, long offset) throw (RangeException, DOMException);
| Parameter | Description |
|---|---|
refNode | reference node |
offset | offset |
Sets the end pointer after a specified node.
Syntax
void setEndAfter( NodeRef< Node>& refNode) throw (RangeException);
| Parameter | Description |
|---|---|
refNode | reference node |
Set the end before a specified node.
Syntax
void setEndBefore( NodeRef< Node>& refNode) throw (RangeException);
| Parameter | Description |
|---|---|
refNode | reference node |
Sets start point.
Syntax
void setStart( NodeRef< Node>& refNode, long offset) throw (RangeException, DOMException);
| Parameter | Description |
|---|---|
refNode | reference node |
offset | offset |
Sets start pointer after a specified node.
Syntax
void setStartAfter( NodeRef< Node>& refNode) throw (RangeException);
| Parameter | Description |
|---|---|
refNode | reference node |
Sets start pointer before a specified node.
Syntax
void setStartBefore( NodeRef< Node>& refNode) throw (RangeException);
| Parameter | Description |
|---|---|
refNode | reference node |
Makes a node into a child of the specified node.
Syntax
void surroundContents( NodeRef< Node>& newParent) throw (RangeException, DOMException);
| Parameter | Description |
|---|---|
newParent | parent node |
Converts an item into a string.
Syntax
oratext* toString();
Returns
(oratext*) string representation of the range
Table 2-25 summarizes the methods available through RangeException interface.
Table 2-25 Summary of RangeException Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Get Oracle XML error code embedded in the exception. |
|
|
Get current language (encoding) of error messages. |
|
|
Get Oracle XML error message. |
|
|
Get Range exception code embedded in the exception. |
Gets Oracle XML error code embedded in the exception. Virtual member function inherited from XmlException.
Syntax
virtual unsigned getCode() const = 0;
Returns
(unsigned) numeric error code (0 on success)
Gets the current language encoding of error messages. Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext*) Current language (encoding) of error messages
Get XML error message. Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
This is a virtual member function that defines a prototype for implementation defined member functions returning Range exception codes, defined in RangeExceptionCode, of the exceptional situations during execution.
Syntax
virtual RangeExceptionCode getRangeCode() const = 0;
Returns
(RangeExceptionCode) exception code
Table 2-26 summarizes the methods available through TextRef interface.
Table 2-26 Summary of TextRef Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Split text node into two. |
|
|
Public default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
TextRef( const NodeRef< Node>& node_ref, Node* nptr); | Used to create references to a given text node after a call to createtext. |
TextRef( const TextRef< Node>& nref); | Copy constructor. |
| Parameter | Description |
|---|---|
node_ref | reference to provide the context |
nptr | referenced node |
Returns
(TextRef) Node reference object
Splits a single text node into two text nodes; the original data is split between them. The offset is zero-based, and is in characters, not bytes. The original node is retained, its data is just truncated. A new text node is created which contains the remainder of the original data, and is inserted as the next sibling of the original. The new text node is returned.
Syntax
Node* splitText( ub4 offset) throw (DOMException);
| Parameter | Description |
|---|---|
offset | character offset where to split text |
Returns
(Node*) new node
This is the default destructor.
Syntax
~TextRef();
Table 2-27 summarizes the methods available through TreeWalker interface.
Table 2-27 Summary of TreeWalker Methods; Dom Package
| Function | Summary |
|---|---|
|
|
Attach this tree walker to another context. |
|
|
Get the first child of the current node. |
|
|
Get the last child of the current node. |
|
|
Get the next node. |
|
|
Get the next sibling node. |
|
|
Get the parent of the current node. |
|
|
Get the previous node. |
|
|
Get the previous sibling node. |
Attaches this tree walker to the context associated with a given node reference
Syntax
void adjustCtx( NodeRef< Node>& nref);
| Parameter | Description |
|---|---|
nref | reference to provide the context |
Get the first child of the current node.
Syntax
Node* firstChild();
Returns
(Node*) pointer to first child node
Get the last child of the current node.
Syntax
Node* lastChild();
Returns
(Node*) pointer to last child node
Get the next node.
Syntax
Node* nextNode();
Returns
(Node*) pointer to the next node
Get the next sibling node.
Syntax
Node* nextSibling();
Returns
(Node*) pointer to the next sibling node
Get the parent of the current node.
Syntax
Node* parentNode();
Returns
(Node*) pointer to the parent node
Get the previous node.
Syntax
Node* previousNode();
Returns
(Node*) pointer to previous node
Get the previous sibling node.
Syntax
Node* previousSibling();
Returns
(Node*) pointer to the previous sibling node
This chapter contains these sections:
Table 3-1 summarizes the datatypes of the IO package.
Defines input source types.
Definition
typedef enum InputSourceType {
ISRC_URI = 1,
ISRC_FILE = 2,
ISRC_BUFFER = 3,
ISRC_DOM = 4,
ISRC_CSTREAM = 5 }
InputSourceType;
Table 3-2 summarizes the methods available through the IO interface
Table 3-2 Summary of IO Package Interfaces
| Function | Summary |
|---|---|
|
|
Get the base URI. |
|
|
Get the input source type. |
|
|
Set the base URI. |
Gets the base URI. It is used by some input sources such as File and URI.
Syntax
oratext* getBaseURI() { return baseURI; }
Returns
(oratext*) base URI
Gets the input source type.
Syntax
InputSourceType getISrcType() const { return isrctype; }
Returns
(InputSourceType) input source type
Sets the base URI. It is used by some input sources such as File and URI.
Syntax
void setBaseURI( oratext* base_URI) baseURI = base_URI; }
Copyright © 1994-2012, Oracle and/or its affiliates. All rights reserved.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
If this document is in prerelease status:
This documentation is in prerelease status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.
XPointer package contains XPointer processing related types and interfaces.
This chapter contains the following sections:
Table 9-1 summarizes the datatypes of the XPointer package.
Table 9-1 Summary of Datatypes; XPointer Package
| Datatype | Description |
|---|---|
|
|
Defines XPath compiler identifiers. |
|
|
Defines XPointer processor identifiers. |
|
|
Defines location types for XPointer. |
XPointer related exception codes.
Definition
typedef enum XPathCompIdType {
XvmXPathCompCXml = 1
} XPathCompIdType;
Defines XPointer processor identifiers.
Definition
typedef enum XppPrIdType { XPtrPrCXml = 1} XppPrIdType;
Defines location types for XPointer.
Definition
typedef enum XppLocType {
XPPLOC_TYPE_UNKNOWN = 0,
XPPLOC_TYPE_NODE = 1,
XPPLOC_TYPE_POINT = 2,
XPPLOC_TYPE_RANGE = 3,
XPPLOC_TYPE_BOOL = 4,
XPPLOC_TYPE_NUM = 5,
XPPLOC_TYPE_STR = 6
} XppLocType;
Table 9-2 summarizes the methods available through the Processor interface.
Table 9-2 Summary of Processor Methods; XPointer Package
| Function | Summary |
|---|---|
|
|
Get processor's Id. |
|
|
Evaluate XPointer expression against given document. |
Get Processor Id.
Syntax
virtual XppPrIdType getProcessorId() const = 0;
Returns
(XppPrIdType) Processor's Id
Evaluates XPointer expression against given document and returns result XPointer location set object.
Syntax
virtual XppLocSet< Node>* process ( InputSource* isrc_ptr, oratext* xpp_exp) throw (XppException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | instance document to process |
xpp_exp | XPointer expression |
Returns
(XppLocSet*) XPath object
Table 9-3 summarizes the methods available through the XPPException interface.
Table 9-3 Summary of XppException Methods; Package XPointer
| Function | Summary |
|---|---|
|
|
Get Oracle XML error code embedded in the exception. |
|
|
Get current language (encoding) of error messages. |
|
|
Get Oracle XML error message. |
|
|
Get XPointer exception code embedded in the exception. |
Virtual member function inherited from XmlException.
Syntax
virtual unsigned getCode() const = 0;
Returns
(unsigned) numeric error code (0 on success)
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext*) Current language (encoding) of error messages
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
This is a virtual member function that defines a prototype for implementation defined member functions returning XPointer processor and compiler exception codes, defined in XppExceptionCode, of the exceptional situations during execution.
Syntax
virtual XppExceptionCode getXppCode() const = 0;
Returns
(XppExceptionCode) exception code
Table 9-4 summarizes the methods available through the XppLocation interface.
Table 9-4 Summary of XppLocation Methods; XPointer Package
| Function | Summary |
|---|---|
|
|
Get the location type. |
|
|
Get the node. |
|
|
Get range. |
Get the location type.
Syntax
XppLocType getLocType() const;
Get the node.
Syntax
Node* getNode() const;
Get range.
Syntax
Range< Node>* getRange() const;
Table 9-5 summarizes the methods available through the XppLocSet interface.
Table 9-5 Summary of XppLocSet Methods; XPointer Package
| Function | Summary |
|---|---|
|
|
Get item given its index. |
|
|
Get location set size. |
Returns a reference to the item.
Syntax
XppLocation< Node>* getItem( ub4 index) const;
| Parameter | Description |
|---|---|
index | index of an item |
Returns
(XppLocation*) reference to the item
The size of the node set.
Syntax
ub4 getSize() const;
Returns
(ub4) node set size
Tools packages contains types and interfaces related to the creation and instantiation of Oracle XML tools.
This chapter contains this section:
Table 7-1 summarizes the datatypes of the Tools package.
Tool Factory exceptions.
Definition
typedef enum FactoryExceptionCode {
FACTORY_UNDEFINED_ERR = 0,
FACTORY_OTHER_ERR = 1
} FactoryExceptionCode;
Table 7-2 summarizes the methods available through the Factory interface.
Table 7-2 Summary of Factory Methods; Tools Package
| Function | Summary |
|---|---|
|
|
Constructor. |
|
|
Create DOM Parser. |
|
|
Create SAX Parser. |
|
|
Create schema validator. |
|
|
Create extended XPath processor. |
|
|
Create XPath compiler. |
|
|
Create XPath processor. |
|
|
Create XPointer processor. |
|
|
Create Xsl compiler. |
|
createXslExtendedTransformer() |
Create XSL extended transformer. |
|
|
Create XSL transformer. |
|
|
Get factory's context. |
|
|
Default destructor. |
Class constructor.
| Syntax | Description |
|---|---|
Factory() throw (FactoryException); | Default constructor |
Factory( Context* ctx_ptr) throw (FactoryException); | Creates factory object given a Context object. |
| Parameter | Description |
|---|---|
ctx_ptr | pointer to a context object |
Returns
(Factory) object
Creates DOM parser.
Syntax
DOMParser< Context, Node>* createDOMParser ( DOMParserIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | parser id type |
ctx_ptr | pointer to a Context object |
Returns
(DOMParser*) pointer to the parser object
Creates SAX parser.
Syntax
SAXParser< Context>* createSAXParser ( SAXParserIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | parser id type |
ctx_ptr | pointer to a Context object |
Returns
(SAXParser*) pointer to the parser object
Creates schema validator.
Syntax
SchemaValidator< Node>* createSchemaValidator ( SchValidatorIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | validator id type |
ctx_ptr | pointer to a Context object |
Returns
(SchemaValidator*) pointer to the validator object
Creates extended XPath processor; takes XvmPrCXml value only.
Syntax
CompProcessor< Context, Node>* createXPathCompProcessor ( XPathPrIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | processor id type |
ctx_ptr | pointer to a Context object |
Returns
(CompProcessor*) pointer to the processor object
Creates XPath compiler.
Syntax
XPath::Compiler< Context, Node>* createXPathCompiler ( XPathCompIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | compiler id type |
ctx_ptr | pointer to a Context object |
Returns
(XPathCompiler*) pointer to the compiler object
Creates XPath processor.
Syntax
XPath::Processor< Context, Node>* createXPathProcessor ( XPathPrIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | processor id type |
ctx_ptr | pointer to a Context object |
Returns
(Processor*) pointer to the processor object
Creates XPointer processor.
Syntax
XPointer::Processor< Context, Node>* createXPointerProcessor ( XppPrIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | processor id type |
ctx_ptr | pointer to a Context object |
Returns
(Processor*) pointer to the processor object
Creates Xsl compiler.
Syntax
Xsl::Compiler< Context, Node>* createXslCompiler ( XslCompIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | compiler id type |
ctx_ptr | pointer to a Context object |
Returns
(Compiler*) pointer to the compiler object
Creates XSL extended trnasformer; takes XvmTrCXml value only.
Syntax
CompTransformer< Context, Node>* createXslExtendedTransformer ( XslTrIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | transformer id type |
ctx_ptr | pointer to a Context object |
Returns
(CompTrasformer*) pointer to the transformer object
Creates XSL trnasformer.
Syntax
Transformer< Context, Node>* createXslTransformer ( XslTrIdType id_type, Context* ctx_ptr = NULL) throw (FactoryException);
| Parameter | Description |
|---|---|
id_type | transformer id type |
ctx_ptr | pointer to a Context object |
Returns
(Trasformer*) pointer to the transformer object
Returns factory's context.
Syntax
Context* getContext() const;
Returns
(Context*) pointer to the context object
Default destructor.
Syntax
~Factory();
Table 7-3 summarizes the methods available through the FactoryException interface.
Table 7-3 Summary of FactoryException Methods; Tools Package
| Function | Summary |
|---|---|
|
|
Get Oracle XML error code embedded in the exception. |
|
|
Get FactoryException code embedded in the exception. |
|
|
Get current language (encoding) of error messages. |
|
|
Get Oracle XML error message. |
Gets Oracle XML error code embedded in the exception. Virtual member function inherited from XmlException.
Syntax
virtual unsigned getCode() const = 0;
Returns
(unsigned) numeric error code (0 on success)
This is a virtual member function that defines a prototype for implementation defined member functions returning exception codes specific to the Tools namespace, defined in FactoryExceptionCode, of the exceptional situations during execution
Syntax
virtual FactoryExceptionCode getFactoryCode() const = 0;
Returns
(FactoryExceptionCode) exception code
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext*) Current language (encoding) of error messages
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
Ctx is the namespace for TCtx XML context related types and interfaces.
This chapter contains the following sections:
Table 1-1 summarizes the datatypes of the Ctx package.
Table 1-1 Summary of Datatypes; Ctx Package
| Datatype | Description |
|---|---|
|
|
A single supported encoding. |
|
|
An array of encodings. |
A single supported encoding.
Definition
typedef struct encoding {
oratext *encname;
oratext *encvalue;
} encoding;
An array of encodings.
Definition
typedef struct encodings {
unsigned num;
encoding *enc;
} encodings;
Table 1-2 summarizes the methods available through the MemAllocator interface.
Table 1-2 Summary of MemAllocator Methods; Ctx Package
| Function | Summary |
|---|---|
|
|
Allocates memory of given size. |
|
|
Deallocate memory pointed to by the argument. |
|
|
Virtual destructor - interface level handle to actual destructors. |
This is a virtual member function that defines a prototype for user defined allocator functions
Syntax
virtual void* alloc( ub4 size) = 0;
| Parameter | Description |
|---|---|
size | memory size |
This is a virtual member function that defines a prototype for user defined deallocator functions. Such deallocators are supposed to deallocate memory allocated by the alloc member functions
Syntax
virtual void dealloc( void* ptr) = 0;
| Parameter | Description |
|---|---|
ptr | pointer to previously allocated memory |
It provides an interface level handle to actual destructors that can be invoked without knowing their names or implementations
Syntax
virtual ~MemAllocator() {}
Table 1-3 summarizes the methods available through the TCtx interface.
Table 1-3 Summary of TCtx Methods; Ctx Package
| Function | Summary |
|---|---|
|
|
Class constructor. |
|
|
Get data encoding in use by XML context. |
|
|
Get Error Handler provided by the user. |
|
|
Get memory allocator. |
|
|
Get a flag that indicates if data encoding is simple. |
|
|
Get a flag indicating if data encoding is Unicode. |
|
|
Destructor - clears space and destroys the implementation. |
TCtx constructor. It throws XmlException if it fails to create a context object.
| Syntax | Description |
|---|---|
TCtx() throw (XMLException) | This constructor creates the context object and initializes it with default values of parameters. |
TCtx( oratext* name, ErrorHandler* errh = NULL, MemAllocator* memalloc = NULL, encodings* encs = NULL) throw (XMLException) | This constructor creates the context object and initializes it with parameter values provided by the user. |
TCtx( oratext* name, up4 inpblksize, ErrorIfs* errh = NULL, MemAllocator* memalloc = NULL, encodings* encs = NULL) throw (XMLException) | This constructor creates the context object and initializes it with parameter values provided by the user. Takes an additional parameter for memory block size from input source. |
| Parameter | Description |
|---|---|
name | user defined name of the context |
errh | user defined error handler |
memalloc | user defined memory allocator |
encs | user specified encodings |
inpblksize | memory block size for input source |
Returns
(TCtx) Context object
Returns data encoding in use by XML context. Ordinarily, the data encoding is chosen by the user, so this function is not needed. However, if the data encoding is not specified, and allowed to default, this function can be used to return the name of that default encoding.
Syntax
oratext* getEncoding() const;
Returns
(oratext *) name of data encoding
This member functions returns Error Handler provided by the user when the context was created, or NULL if none were provided.
Syntax
ErrorHandler* getErrHandler() const;
Returns
(ErrorHandler *) Pointer to the Error Handler object, or NULL
This member function returns memory allocator provided by the user when the context was created, or default memory allocator. It is important that this memory allocator is used for all C level memory allocations
Syntax
MemAllocator* getMemAllocator() const;
Returns
(MemAllocator*) Pointer to the memory allocator object
Returns a flag saying whether the context's data encoding is "simple", single-byte for each character, like ASCII or EBCDIC.
Syntax
boolean isSimple() const;
Returns
(boolean) TRUE of data encoding is "simple", FALSE otherwise
Returns a flag saying whether the context's data encoding is Unicode, UTF-16, with two-byte for each character.
Syntax
boolean isUnicode() const;
Returns
(boolean) TRUE if data encoding is Unicode, FALSE otherwise
Destructor - should be called by the user the context object is no longer needed
Syntax
~Tctx();
W3C: "SOAP is a lightweight protocol for exchange of information in a decentralized, distributed environment. It is an XML based protocol that consists of three parts: an envelope that defines a framework for describing what is in a message and how to process it, a set of encoding rules for expressing instances of application-defined datatypes, and a convention for representing remote procedure calls and responses."
The structure of a SOAP message is:
[SOAP message (XML document)
[SOAP envelope
[SOAP header?
element*
]
[SOAP body
(element* | Fault)?
]
]
]
This chapter contains the following sections:
Table 6-1 summarizes the datatypes of the SOAP package.
Table 6-1 Summary of Datatypes; SOAP Package
| Datatype | Description |
|---|---|
|
|
Defines Soap-related exception codes. |
|
|
Defines binding for SOAP connections. |
|
|
Defines roles for SOAP nodes. |
Defines Soap-related exception codes.
typedef enum SoapExceptionCode {
SOAP_UNDEFINED_ERR = 0,
SOAP_OTHER_ERR = 1} SoapExceptionCode;
Defines binding for SOAP connections. HTTP is currently the only choice.
typedef enum SoapBinding {
BIND_NONE = 0, /* none */
BIND_HTTP = 1 /* HTTP */ } SoapBinding;
Defines roles for SOAP nodes.
typedef enum SoapRole {
ROLE_UNSET = 0, /* not specified */
ROLE_NONE = 1, /* "none" */
ROLE_NEXT = 2, /* "next" */
ROLE_ULT = 3 /* "ultimateReceiver" */ } SoapRole;
Table 6-2 summarizes the methods available through the SoapException Interface.
Table 6-2 Summary of SoapException Interfaces
| Datatype | Description |
|---|---|
|
Get Oracle XML error code embedded in the exception | |
|
Get Oracle XML error message. | |
|
Get current language encoding of error messages. | |
|
Get Soap exception code embedded in the exception. |
Get Oracle XML error code embedded in the exception. This is a virtual member function inherited from XMLException.
Syntax
virtual unsigned getCode() const = 0;
Returns
(unsigned) numeric error code (0 on success)
Get Oracle XML error message. Virtual member function inherited from XMLException.
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
Get current language encoding of error messages. Virtual member function inherited from XMLException.
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext*) Current language (encoding) of error messages
Get SOAP exception code embedded in the exception. This is a virtual member function that defines a prototype for implementing defined member functions that return SOAP API exception codes.
Syntax
virtual SoapExceptionCode getSoapCode() const = 0;
Returns
(SoapExceptionCode) exception code
Table 6-3 summarizes the methods available ConnectRef Interface.
Table 6-3 Summary of ConnectRef Interfaces
| Datatype | Description |
|---|---|
|
Destroys a SOAP connection object | |
|
Send a SOAP message then waits for a response. |
Destructor. Destroys a SOAP connection object and frees any resources associated with it.
Syntax
~ConnectRef() throw (SoapException);
Send a SOAP message then waits for a response.
Syntax
DocumentRef< Node>* call( DocumentRef< Node>& msg) throw (SoapException);
| Parameter | Description |
|---|---|
msg | The SOAP message that is sent. |
Returns
(DocumentRef) returned message
Table 6-4 summarizes the methods available through the MsgFactory Interface.
Table 6-4 Summary of MsgFactory Interfaces
| Datatype | Description |
|---|---|
|
Destroys the SOAP message factory instance. | |
|
Creates and returns a SOAP Message Factory instance. | |
|
Adds an element to a SOAP message body. | |
|
Add s an additional Reason to Fault | |
|
Adds an element to SOAP header. | |
|
Creates a SOAP connection. | |
|
Creates and returns an empty SOAP message. | |
|
Destroyw a SOAP message. | |
|
Returns a SOAP message's envelope body.. | |
|
Gets an element from a SOAP body. | |
|
Returns a SOAP part's envelope. | |
|
Returns Fault code, reason, and details. | |
|
Returns a SOAP message's envelope header.. | |
|
Gets an element from a SOAP header. | |
|
Gets | |
|
Gets the number of reasons in | |
|
Gets a language of a reason with a particular index. | |
|
Gets role from SOAP header element. | |
|
Determines if a SOAP message contains a Fault object. | |
|
Sets Fault in a SOAP message. | |
|
Sets | |
|
Sets the role for SOAP header element. |
Destructor. Destroys the SOAP message factory. All allocated memory is frieed and all connections are closed.
Syntax
~MsgFactory() throw (SoapException);
Creates and returns a SOAP Message Factory instance.
Syntax
MsgFactory( Context* ctx_ptr) throw (SoapException);
| Parameter | Description |
|---|---|
ctx_ptr | TContext object |
Returns
(MsgFactory) object
Adds an element to a SOAP message body.
Syntax
Node* addBodyElement( DocumentRef< Node>& msg, oratext *qname, oratext *uri) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
qname | QName of element to add |
uri | Namespace URI of element to add |
Returns
(Node*) pointer to the created element
Adds an additional Reason to Fault. The same re son text may be provided in different languages. When the fault is created, the primary language and reasonare added at that time; use this function to add additional translations of the reason.
Syntax
void addFaultReason( DocumentRef< Node>& msg, oratext *reason, oratext *lang) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
reason | Human-readable fault reason |
lang | Language of reason |
Adds an element to SOAP header.
Syntax
Node* addHeaderElement( DocumentRef< Node>& msg, oratext *qname, oratext *uri) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
qname | QName of element to add |
uri | Namespace URI of element to add |
Returns
(Node*) pointer to the created element
Creates a SOAP connection object. The connection reference object should explicitly deleted by the user.
Syntax
ConnectRef< Node>* createConnection( SoapBinding bind, void *endp, oratext *buf, ubig_ora bufsiz, oratext *msgbuf, ubig_ora msgbufsiz) throw (SoapException);
| Parameter | Description |
|---|---|
bind | connection binding |
endp | connection endpoint |
buf | data buffer (or NULL to have one allocated) |
bufsiz | size of data buffer (or 0 for default size) |
msgbuf | message buffer (or NULL to have one allocated) |
msgfubsiz | size of message buffer (or 0 for default size) |
Returns
(ConnectRef) connect object
Creates and returns an empty SOAP message. The reference object should be explicitly deleted by the user when no longer needed.
Syntax
DocumentRef< Node>* CreateMessage() throw (SoapException);
Returns
(DocumentRef*) SOAP message, or an exception
Destroys a SOAP message.
Syntax
void destroyMessage( DocumentRef< Node>& msg) throw (SoapException);
| Parameter | Description |
|---|---|
msg | The SOAP message. |
Returns a SOAP message's envelope body as a pointer to the body's element node.
Syntax
Node* getBody( DocumentRef<Node>& msg) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
Returns
(Node*) pointer to the SOAP message's envelope body
Gets an element from a SOAP body as a pointer to its element node.
Syntax
Node* getBodyElement( DocumentRef< Node>& msg, oratext *uri, oratext *local) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
uri | Namespace URI of element to add |
local | Local name of element to get |
Returns
(Node*) pointer to the named element
Returns a SOAP part's envelope as a pointer to envelope element node.
Syntax
Node* getEnvelope( DocumentRef<Node>& msg) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
Returns
(Node*) pointer to the SOAP message's envelope
Returns Fault code, reason, and details through user variables. NULL may be supplied for any part that is not needed. For lang, if the pointed-to variable is NULL, it will be set to the default language, that of the first reason.
Syntax
Node* getFault( DocumentRef< Node>& msg, oratext **code, oratext **reason, oratext **lang, oratext **node, oratext **role) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
code | Fault code |
reason | Human-readable fault reason |
lang | Desired reason language or NULL (default language, same as for the first reason) |
node | Fault node |
role | Role: next, none, or ulitmate receiver (not used in 1.1) |
Returns
(Node) pointer to the detail
Returns a SOAP message's envelope header as a pointer to the header element node.
Syntax
Node* getHeader( DocumentRef< Node>& msg) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
Returns
(Node*) pointer to the SOAP message's envelope header
Gets an element from a SOAP header as a pointer to its element node.
Syntax
Node* getHeaderElement( DocumentRef< Node>& msg, oratext *uri, oratext *local) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
uri | Namespace URI of element to get |
local | Local name of element to get |
Returns
(Node*) pointer to the named element
Gets mustUnderstand attribute from SOAP header element.
Syntax
boolean getMustUnderstand( ElementRef< Node>& elem) throw (SoapException);
| Parameter | Description |
|---|---|
elem | SOAP header element |
Returns
(boolean) value of the mustUnderstand attribute
Determines the number of reasons in the Fault element. Returns 0 if no Fault.
Syntax
ub4 getReasonNum( DocumentRef< Node>& msg) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
Returns
(up4) number of reasons in Fault element
Returns the language of a reason with a particular index.
Syntax
oratext* getReasonLang( DocumentRef< Node>& msg, ub4 idx) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
idx | index of a fault reason |
Returns
(oratext *) value of property or NULL.
Gets role from SOAP header element.
Syntax
SoapRole getRole( ElementRef< Node>& elem) throw (SoapException);
| Parameter | Description |
|---|---|
elem | Reference to the header element |
Returns
(SoapRole) header element's role
Determines if a SOAP message contains a Fault object.
Syntax
boolean hasFault( DocumentRef< Node>& msg) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
Returns
(boolean) TRUE if there's a Fault, FALSE if not
Sets Fault in a SOAP message.
Syntax
void setFault( DocumentRef< Node>& msg, oratext *node, oratext *code, oratext *reason, oratext *lang, oratext *role, ElementRef< Node>& detail) throw (SoapException);
| Parameter | Description |
|---|---|
msg | SOAP message |
node | URI of SOAP node which faulted |
code | Fault code |
reason | Human-readable fault reason |
lang | Language |
role | URI representing role, Role (1.2), unused (1.1) |
detail | User-defined elements |
Sets mustUnderstand attribute for the SOAP header element.
Syntax
void setMustUnderstand( ElementRef< Node>& elem, boolean mustUnderstand) throw (SoapException);
| Parameter | Description |
|---|---|
elem | SOAP header element |
mustUnderstand | mustUnderstand value (TRUE or FALSE) |
Sets the role for SOAP header element.
Syntax
void setRole( ElementRef< Node>& elem, SoapRole role) throw (SoapException);
| Parameter | Description |
|---|---|
elem | reference to the header element |
role | role value |
Parser interfaces include: Parser exceptions, Validator, Parser, DOMParser, and SAXParser.
This chapter contains the following sections:
Table 5-1 summarizes the datatypes of the Parser package.
Table 5-1 Summary of Datatypes; Parser Package
| Datatype | Description |
|---|---|
|
|
Parser implementation of exceptions. |
|
|
Defines parser identifiers. |
|
|
Defines type of node. |
|
|
Defines validator identifiers. |
Parser implementation of exceptions.
Definition
typedef enum ParserExceptionCode {
PARSER_UNDEFINED_ERR = 0,
PARSER_VALIDATION_ERR = 1,
PARSER_VALIDATOR_ERR = 2,
PARSER_BAD_ISOURCE_ERR = 3,
PARSER_CONTEXT_ERR = 4,
PARSER_PARAMETER_ERR = 5,
PARSER_PARSE_ERR = 6,
PARSER_SAXHANDLER_SET_ERR = 7,
PARSER_VALIDATOR_SET_ERR = 8 }
ParserExceptionCode;
Defines parser identifiers.
Definition
typedef enum DOMParserIdType { DOMParCXml = 1 } DOMParserIdType;
ypedef enum CompareHowCode {
START_TO_START = 0,
START_TO_END = 1,
END_TO_END = 2,
END_TO_START = 3 }
CompareHowCode;
Defines parser identifiers.
Definition
typedef enum SAXParserIdType {
SAXParCXml = 1 }
SAXParserIdType;
Defines validator identifiers.These identifiers are used as parameters to the XML tools factory when a particular validator object has to be created.
Definition
typedef enum SchValidatorIdType {
SchValCXml = 1
} SchValidatorIdType;
Table 5-2 summarizes the methods available through the DOMParser interface.
Table 5-2 Summary of DOMParser Methods; Parser Package
| Function | Summary |
|---|---|
|
|
Returns parser's XML context (allocation and encodings). |
|
|
Get parser id. |
|
|
Parse the document. |
|
|
Parse DTD document. |
|
|
Parse and validate the document. |
|
|
Set the validator for this parser. |
Each parser object is allocated and executed in a particular Oracle XML context. This member function returns a pointer to this context.
Syntax
virtual Context* getContext() const = 0;
Returns
(Context*) pointer to parser's context
Syntax
virtual DOMParserIdType getParserId() const = 0;
Returns
(DOMParserIdType) Parser Id
Parses the document and returns the tree root node
Syntax
virtual DocumentRef< Node>* parse( InputSource* isrc_ptr, boolean DTDvalidate = FALSE, DocumentTypeRef< Node>* dtd_ptr = NULL, boolean no_mod = FALSE, DOMImplementation< Node>* impl_ptr = NULL) throw (ParserException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | input source |
DTDvalidate | TRUE if validated by DTD |
dtd_ptr | DTD reference |
no_mod | TRUE if no modifications allowed |
impl_ptr | optional DomImplementation pointer |
Returns
(DocumentRef) document tree
Parse DTD document.
Syntax
virtual DocumentRef< Node>* parseDTD( InputSource* isrc_ptr, boolean no_mod = FALSE, DOMImplementation< Node>* impl_ptr = NULL) throw (ParserException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | input source |
no_mod | TRUE if no modifications allowed |
impl_ptr | optional DomImplementation pointer |
Returns
(DocumentRef) DTD document tree
Parses and validates the document. Sets the validator if the corresponding parameter is not NULL.
Syntax
virtual DocumentRef< Node>* parseSchVal( InputSource* src_par, boolean no_mod = FALSE, DOMImplementation< Node>* impl_ptr = NULL, SchemaValidator< Node>* tor_ptr = NULL) throw (ParserException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | input source |
no_mod | TRUE if no modifications allowed |
impl_ptr | optional DomImplementation pointer |
tor_ptr | schema validator |
Returns
(DocumentRef) document tree
Sets the validator for all validations except when another one is given in parseSchVal
Syntax
virtual void setValidator( SchemaValidator< Node>* tor_ptr) = 0;
| Parameter | Description |
|---|---|
tor_ptr | schema validator |
Table 5-3 summarizes the methods available through the GParser interface.
Table 5-3 Summary of GParser Methods; Parser Package
| Function | Summary |
|---|---|
|
|
Specifies if multiple entity declarations result in a warning. |
|
|
Returns the base URI for the document. |
|
|
Checks if whitespaces between elements are discarded. |
|
|
Checks if character references are expanded. |
|
|
Get schema location for this document. |
|
|
Get if document processing stops on warnings. |
|
|
Get if multiple entity declarations cause a warning. |
|
|
Sets the base URI for the document. |
|
|
Sets if formatting whitespaces should be discarded. |
|
|
Get if character references are expanded. |
|
|
Set schema location for this document. |
|
|
Sets if document processing stops on warnings. |
Specifies if entities that are declared more than once will cause warnings to be issued.
Syntax
void setWarnDuplicateEntity( boolean par_bool);
| Parameter | Description |
|---|---|
par_bool | TRUE if multiple entity declarations cause a warning |
Returns the base URI for the document. Usually only documents loaded from a URI will automatically have a base URI. Documents loaded from other sources (stdin, buffer, and so on) will not naturally have a base URI, but a base URI may have been set for them using setBaseURI, for the purposes of resolving relative URIs in inclusion.
Syntax
oratext* getBaseURI() const;
Returns
(oratext *) current document's base URI [or NULL]
Checks if formatting whitespaces between elements, such as newlines and indentation in input documents are discarded. By default, all input characters are preserved.
Syntax
boolean getDiscardWhitespaces() const;
Returns
(boolean) TRUE if whitespace between elements are discarded
Checks if character references are expanded in the DOM data. By default, character references are replaced by the character they represent. However, when a document is saved those characters entities do not reappear. To ensure they remain through load and save, they should not be expanded.
Syntax
boolean getExpandCharRefs() const;
Returns
(boolean) TRUE if character references are expanded
Gets schema location for this document. It is used to figure out the optimal layout when loading documents into a database.
Syntax
oratext* getSchemaLocation() const;
Returns
(oratext*) schema location
When TRUE is returned, warnings are treated the same as errors and cause parsing, validation, and so on, to stop immediately. By default, warnings are issued but the processing continues.
Syntax
boolean getStopOnWarning() const;
Returns
(boolean) TRUE if document processing stops on warnings
Get if entities which are declared more than once will cause warnings to be issued.
Syntax
boolean getWarnDuplicateEntity() const;
Returns
(boolean) TRUE if multiple entity declarations cause a warning
Sets the base URI for the document. Usually only documents that were loaded from a URI will automatically have a base URI. Documents loaded from other sources (stdin, buffer, and so on) will not naturally have a base URI, but a base URI may have been set for them using setBaseURI, for the purposes of resolving relative URIs in inclusion.
Syntax
void setBaseURI( oratext* par);
| Parameter | Description |
|---|---|
par | base URI |
Sets if formatting whitespaces between elements (newlines and indentation) in input documents are discarded. By default, ALL input characters are preserved.
Syntax
void setDiscardWhitespaces( boolean par_bool);
| Parameter | Description |
|---|---|
par_bool | TRUE if whitespaces should be discarded |
Sets if character references should be expanded in the DOM data. Ordinarily, character references are replaced by the character they represent. However, when a document is saved those characters entities do not reappear. To ensure they remain through load and save is to not expand them.
Syntax
void setExpandCharRefs( boolean par_bool);
| Parameter | Description |
|---|---|
par_bool | TRUE if character references should be discarded |
Sets schema location for this document. It is used to figure out the optimal layout when loading documents into a database.
Syntax
void setSchemaLocation( oratext* par);
| Parameter | Description |
|---|---|
par | schema location |
When TRUE is set, warnings are treated the same as errors and cause parsing, validation, and so on, to stop immediately. By default, warnings are issued but the processing continues.
Syntax
void setStopOnWarning( boolean par_bool);
| Parameter | Description |
|---|---|
par_bool | TRUE if document processing should stop on warnings |
Table 5-4 summarizes the methods available through the ParserException interface.
Table 5-4 Summary of ParserException Methods; Parser Package
| Function | Summary |
|---|---|
|
|
Get Oracle XML error code embedded in the exception. |
|
|
Get current language (encoding) of error messages. |
|
|
Get Oracle XML error message. |
|
|
Get parser exception code embedded in the exception. |
Virtual member function inherited from XmlException.
Syntax
virtual unsigned getCode() const = 0;
Returns
(unsigned) numeric error code (0 on success)
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext*) Current language (encoding) of error messages
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
This is a virtual member function that defines a prototype for implementation defined member functions returning parser and validator exception codes, defined in ParserExceptionCode, of the exceptional situations during execution.
Syntax
virtual ParserExceptionCode getParserCode() const = 0;
Returns
(ParserExceptionCode) exception code
Table 5-5 summarizes the methods available through the SAXHandler interface.
Table 5-5 Summary of SAXHandler Methods; Parser Package
| Function | Summary |
|---|---|
|
|
Receive notification of CDATA. |
|
|
Receive notification of an XML declaration. |
|
|
Receive notification of attribute's declaration. |
|
|
Receive notification of character data. |
|
|
Receive notification of a comment. |
|
|
Receive notification of element's declaration. |
|
|
Receive notification of the end of the document. |
|
|
Receive notification of element's end. |
|
|
Receive notification of a notation declaration. |
|
|
Receive notification of a parsed entity declaration. |
|
|
Receive notification of a processing instruction. |
|
|
Receive notification of the start of the document. |
|
|
Receive notification of element's start. |
|
|
Receive namespace aware notification of element's start. |
|
|
Receive notification of an unparsed entity declaration. |
|
|
Receive notification of whitespace characters. |
This event handles CDATA, as distinct from Text. The data will be in the data encoding, and the returned length is in characters, not bytes. This is an Oracle extension.
Syntax
virtual void CDATA( oratext* data, ub4 size) = 0;
| Parameter | Description |
|---|---|
data | pointer to CDATA |
size | size of CDATA |
This event marks an XML declaration (XMLDecl). The startDocument event is always first; this event will be the second event. The encoding flag says whether an encoding was specified. For the standalone flag, -1 will be returned if it was not specified, otherwise 0 for FALSE, 1 for TRUE. This member function is an Oracle extension.
Syntax
virtual void XMLDecl( oratext* version, boolean is_encoding, sword standalone) = 0;
| Parameter | Description |
|---|---|
version | version string from XMLDecl |
is_encoding | whether encoding was specified |
standalone | value of standalone value flag |
This event marks an attribute declaration in the DTD. It is an Oracle extension; not in SAX standard
Syntax
virtual void attributeDecl( oratext* attr_name, oratext *name, oratext *content) = 0;
| Parameter | Description |
|---|---|
attr_name | |
name | |
content | body of attribute declaration |
This event marks character data.
Syntax
virtual void characters( oratext* ch, ub4 size) = 0;
| Parameter | Description |
|---|---|
ch | pointer to data |
size | length of data |
This event marks a comment in the XML document. The comment's data will be in the data encoding. It is an Oracle extension, not in SAX standard.
Syntax
virtual void comment( oratext* data) = 0;
| Parameter | Description |
|---|---|
data | comment's data |
This event marks an element declaration in the DTD. It is an Oracle extension; not in SAX standard.
Syntax
virtual void elementDecl( oratext *name, oratext *content) = 0;
| Parameter | Description |
|---|---|
name | element's name |
content | element's content |
Receive notification of the end of the document.
Syntax
virtual void endDocument() = 0;
This event marks the end of an element. The name is the tagName of the element (which may be a qualified name for namespace-aware elements) and is in the data encoding.
Syntax
virtual void endElement( oratext* name) = 0;
The even marks the declaration of a notation in the DTD. The notation's name, public ID, and system ID will all be in the data encoding. Both IDs are optional and may be NULL.
Syntax
virtual void notationDecl( oratext* name, oratext* public_id, oratext* system_id) = 0;
| Parameter | Description |
|---|---|
name | notations's name |
public_id | notation's public Id |
sysem_id | notation's system Id |
Marks a parsed entity declaration in the DTD. The parsed entity's name, public ID, system ID, and notation name will all be in the data encoding. This is an Oracle extension.
Syntax
virtual void parsedEntityDecl( oratext* name, oratext* value, oratext* public_id, oratext* system_id, boolean general) = 0;
| Parameter | Description |
|---|---|
name | entity's name |
value | entity's value if internal |
public_id | entity's public Id |
sysem_id | entity's system Id |
general | whether a general entity (FALSE if parameter entity) |
This event marks a processing instruction. The PI's target and data will be in the data encoding. There is always a target, but the data may be NULL.
Syntax
virtual void processingInstruction( oratext* target, oratext* data) = 0;
| Parameter | Description |
|---|---|
target | PI's target |
data | PI's data |
Receive notification of the start of document.
Syntax
virtual void startDocument() = 0;
This event marks the start of an element.
Syntax
virtual void startElement( oratext* name, NodeListRef< Node>* attrs_ptr) = 0;
| Parameter | Description |
|---|---|
name | element's name |
attrs_ptr | list of element's attributes |
This event marks the start of an element. Note this is the new SAX 2 namespace-aware version. The element's qualified name, local name, and namespace URI will be in the data encoding, as are all the attribute parts.
Syntax
virtual void startElementNS( oratext* qname, oratext* local, oratext* ns_URI, NodeListRef< Node>* attrs_ptr) = 0;
| Parameter | Description |
|---|---|
qname | element's qualified name |
local | element's namespace local name |
ns_URI | element's namespace URI |
attrs_ref | NodeList of element's attributes |
Marks an unparsed entity declaration in the DTD. The unparsed entity's name, public ID, system ID, and notation name will all be in the data encoding.
Syntax
virtual void unparsedEntityDecl( oratext* name, oratext* public_id, oratext* system_id, oratext* notation_name) = 0; };
| Parameter | Description |
|---|---|
name | entity's name |
public_id | entity's public Id |
sysem_id | entity's system Id |
notation_name | entity's notation name |
This event marks ignorable whitespace data such as newlines, and indentation between lines.
Syntax
virtual void whitespace( oratext* data, ub4 size) = 0;
| Parameter | Description |
|---|---|
data | pointer to data |
size | length of data |
Table 5-6 summarizes the methods available through the SAXParser interface.
Table 5-6 Summary of SAXParser Methods; Parser Package
| Function | Summary |
|---|---|
|
|
Returns parser's XML context (allocation and encodings). |
|
|
Returns parser Id. |
|
|
Parse the document. |
|
|
Parse the DTD. |
|
|
Set SAX handler. |
Each parser object is allocated and executed in a particular Oracle XML context. This member function returns a pointer to this context.
Syntax
virtual Context* getContext() const = 0;
Returns
(Context*) pointer to parser's context
Returns the parser id.
Syntax
virtual SAXParserIdType getParserId() const = 0;
Returns
(SAXParserIdType) Parser Id
Parses a document.
Syntax
virtual void parse( InputSource* src_ptr, boolean DTDvalidate = FALSE, SAXHandlerRoot* hdlr_ptr = NULL) throw (ParserException) = 0;
| Parameter | Description |
|---|---|
src_ptr | input source |
DTDValidate | TRUE if validate with DTD |
hdlr_ptr | SAX handler pointer |
Parses a DTD.
Syntax
virtual void parseDTD( InputSource* src_ptr, SAXHandlerRoot* hdlr_ptr = NULL) throw (ParserException) = 0;
| Parameter | Description |
|---|---|
src_ptr | input source |
hdlr_ptr | SAX handler pointer |
Sets SAX handler for all parser invocations except when another SAX handler is specified in the parser call.
Syntax
virtual void setSAXHandler( SAXHandlerRoot* hdlr_ptr) = 0;
| Parameter | Description |
|---|---|
hdlr_ptr | SAX handler pointer |
Table 5-7 summarizes the methods available through the SchemaValidator interface.
Table 5-7 Summary of SchemaValidator Methods; Parser Package
| Function | Summary |
|---|---|
|
|
Return the Schema list. |
|
|
Get validator identifier. |
|
|
Load a schema document. |
|
|
Unload a schema document. |
Return only the size of loaded schema list documents if "list" is NULL. If "list" is not NULL, a list of URL pointers is returned in the user-provided pointer buffer. Note that its user's responsibility to provide a buffer with big enough size.
Syntax
virtual ub4 getSchemaList( oratext **list) const = 0;
| Parameter | Description |
|---|---|
list | address of a pointer buffer |
Returns
(ub4) list size and list of loaded schemas (I/O parameter)
Get the validator identifier corresponding to the implementation of this validator object.
Syntax
virtual SchValidatorIdType getValidatorId() const = 0;
Returns
(SchValidatorIdType) validator identifier
Load up a schema document to be used in the next validation session. Throws an exception in the case of an error.
Syntax
virtual void loadSchema( oratext* schema_URI) throw (ParserException) = 0;
| Parameter | Description |
|---|---|
schema_URI | URL of a schema document; compiler encoding |
Unload a schema document and all its descendants (included or imported in a nested manner from the validator. All previously loaded schema documents will remain loaded until they are unloaded. To unload all loaded schema documents, set schema_URI to be NULL. Throws an exception in the case of an error.
Syntax
virtual void unloadSchema( oratext* schema_URI) throw (ParserException) = 0;
| Parameter | Description |
|---|---|
schema_URI | URL of a schema document; compiler encoding |
OracleXml is the namespace for all XML C++ interaces. It includes class XmlException, the root for all exceptions in XML, and these namespaces:
Ctx - namespace for TCtx related declarations, described in Chapter 1, "Package Ctx APIs for C++"
Dom - namespace for DOM related declarations, described in Chapter 2, "Package Dom APIs for C++"
IO - namespace for input and output source declarations, described in Chapter 3, "Package IO APIs for C++"
Parser - namespace for parser and schema validator declarations, described in Chapter 5, "Package Parser APIs for C++"
SOAP - namespace for the Simple Object Access Protocol declarations, described in Chapter 6, "Package SOAP APIs for C++"
Tools - namespace for Tools::Factory related declarations, described in Chapter 7, "Package Tools APIs for C++"
XPath - namespace for XPath related declarations, described in Chapter 8, "Package XPath APIs for C++"
XPointer - namespace for XPointer related declarations, described in Chapter 9, "Package XPointer APIs for C++"
Xsl - namespace for XSLT related declarations, described in Chapter 10, "Package Xsl APIs for C++"
This chapter contains this section:
XMLException is the root interface for all XML exceptions. Table 4-1 summarizes the methods available through the OracleXml Package.
Table 4-1 Summary of OracleXml Package Interfaces
| Function | Summary |
|---|---|
|
|
Get Oracle XML error code embedded in the exception. |
|
|
Get current language (encoding) of error messages. |
|
|
Get Oracle XML error message. |
This is a virtual member function that defines a prototype for implementation defined functions returning Oracle XML error codes (like error codes defined in xml.h) of the exceptional situations during execution
Syntax
virtual unsigned getCode() const = 0;
Returns
(unsigned) numeric error code (0 on success)
This is a virtual member function that defines a prototype for user defined functions returning current language (encoding) of error messages for the exceptional situations during execution
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext *) Current language (encoding) of error messages
This is a virtual member function that defines a prototype for implementation defined functions returning Oracle XML error messages of the exceptional situations during execution.
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
Xsl package contains XSLT related types and interfaces.
This chapter contains these sections:
Table 10-1 summarizes the datatypes of the Xsl package.
Table 10-1 Summary of Datatypes; Xsl Package
| Datatype | Description |
|---|---|
|
|
Defines XSL compiler identifiers. |
|
|
Defines XSLT related exceptions. |
|
|
Defines XSL transformer identifiers. |
Defines XSL compiler identifiers.
Definition
typedef enum XslCompIdType {
XvmCompCXml = 1
} XslCompIdType;
Defines XSLT related exceptions.
Definition
typedef typedef enum XslExceptionCode {
XSL_UNDEFINED_ERR = 0,
XSL_OTHER_ERR = 1
} XslExceptionCode;
Defines XSL transformer identifiers.
Definition
typedef enum XslTrIdType {
XslTrCXml = 1,
XvmTrCXml = 2
} XslTrIdType;
Table 10-2 summarizes the methods available through the Compiler interface.
Table 10-2 Summary of Compiler Methods; Xsl Package
| Function | Summary |
|---|---|
|
|
Compile Xsl and return its compiled binary representation. |
|
|
Get compiler's Id. |
|
|
Get length of compiled XSL document. |
Compiles Xsl and returns its compiled binary representation.
Syntax
virtual ub2* compile( InputSource* isrc_ptr) throw (XslException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | Xsl document |
Returns
(InputSource) Xsl document in compiled binary representation
Get the compiler Id.
Syntax
virtual XslCompIdType getCompilerId() const = 0;
Returns
(XslCompIdType) Compiler's Id
Returns length of compiled XSL document
Syntax
virtual ub4 getLength( ub2* binxsl_ptr) throw (XslException) = 0;
| Parameter | Description |
|---|---|
binxsl_ptr | compiled Xsl document |
Returns
(ub4) length of the document
Table 10-3 summarizes the methods available through the CompTransformer interface.
Table 10-3 Summary of CompTransformer Methods; Xsl Package
| Function | Summary |
|---|---|
|
|
Get transformer's Id. |
|
|
Set compiled Xsl. |
|
|
Set SAX handler. |
|
|
Set XSLT document for this transformer. |
|
|
Transform the document. |
Get transformer's id.
Syntax
virtual XslTrIdType getTransformerId() const = 0;
Returns
(XslTrIdType) Transformer's Id
Sets compiled Xsl.
Syntax
virtual void setBinXsl ( ub2* binxsl_ptr) throw (XslException) = 0;
| Parameter | Description |
|---|---|
binxsl_ptr | compiled Xsl document |
Inherited from Transformer.
Syntax
virtual void setSAXHandler( SAXHandlerRoot* hdlr_ptr) = 0;
| Parameter | Description |
|---|---|
hdlr_ptr | SAX handler pointer |
Set XSLT document for this transformer. Should be called before the transform member function is called. It is inherited from Transform.
Syntax
virtual void setXSL ( InputSource* isrc_ptr) throw (XslException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | instance document to process |
Transforms the document. Throws an exception if an XSLT document is not set by a previous call to setXSL. Inherited from Transform.
| Syntax | Description |
|---|---|
virtual NodeRef< Node>* transform( nputSource* isrc_ptr) throw (XslException) = 0; | Transform the document and return DOM. |
virtual void transform( InputSource* isrc_ptr, SAXHandlerRoot* hdlr_ptr) throw (XslException) = 0; | Transform the document and return SAX events. |
| Parameter | Description |
|---|---|
isrc_ptr | instance document to process |
hdlr_ptr | SAX handler pointer |
Returns
(DocumentRef) document tree of new document
Table 10-4 summarizes the methods available through the Transformer interface.
Table 10-4 Summary of Transformer Methods; Xsl Package
| Function | Summary |
|---|---|
|
|
Get transformer's Id. |
|
|
Set SAX handler. |
|
|
Set XSLT document for this transformer. |
|
|
Transform the document and return SAX events. |
Gets transformer's id.
Syntax
virtual XslTrIdType getTransformerId() const = 0;
Returns
(XslTrIdType) Transformer's Id
Set SAX handler.
Syntax
virtual void setSAXHandler( SAXHandlerRoot* hdlr_ptr) = 0;
| Parameter | Description |
|---|---|
hdlr_ptr | SAX handler pointer |
Set XSLT document for this transformer. Should be called before the transform member function is called.
Syntax
virtual void setXSL ( InputSource* isrc_ptr) throw (XslException) = 0;
| Parameter | Description |
|---|---|
isrc_ptr | instance document to process |
Transforms the document. Throws an exception if an XSLT document is not set by a previous call to setXSL.
| Syntax | Description |
|---|---|
virtual NodeRef< Node>* transform( nputSource* isrc_ptr) throw (XslException) = 0; | Transform the document and return DOM. |
virtual void transform( InputSource* isrc_ptr, SAXHandlerRoot* hdlr_ptr) throw (XslException) = 0; | Transform the document and return SAX events. |
| Parameter | Description |
|---|---|
isrc_ptr | instance document to process |
hdlr_ptr | SAX handler pointer |
Returns
(DocumentRef) document tree of new document
Table 10-5 summarizes the methods available through the XSLException interface.
Table 10-5 Summary of XSLException Methods; Xsl Package
| Function | Summary |
|---|---|
|
|
Get Oracle XML error code embedded in the exception. |
|
|
Get current language (encoding) of error messages. |
|
|
Get Oracle XML error message. |
|
|
Defines a prototype for implementation. |
Gets Oracle XML error code embedded in the exception. Virtual member function inherited from XmlException.
Syntax
virtual unsigned getCode() const = 0;
Returns
(unsigned) numeric error code (0 on success)
Virtual member function inherited from XmlException.
Syntax
virtual oratext* getMesLang() const = 0;
Returns
(oratext*) Current language (encoding) of error messages
Virtual member function inherited from XmlException
Syntax
virtual oratext* getMessage() const = 0;
Returns
(oratext *) Error message
This is a virtual member function that defines a prototype for implementation defined member functions returning XSL transformer and compiler exception codes, defined in XslExceptionCode, of the exceptional situations during execution.
Syntax
virtual XslExceptionCode getXslCode() const = 0;
Returns
(XslExceptionCode) exception code