9 Package XPointer APIs for C++

XPointer package contains XPointer processing related types and interfaces.

This chapter contains the following sections:

XPointer Datatypes
Processor Interface
XppException Interface
XppLocation Interface
XppLocSet Interface

XPointer Datatypes

Table 9-1 summarizes the datatypes of the XPointer package.

CPXML3074 Table 9-1 Summary of Datatypes; XPointer Package

Datatype	Description
XppExceptionCode	Defines XPath compiler identifiers.
XppPrIdType	Defines XPointer processor identifiers.
XppLocType	Defines location types for XPointer.

CPXML3075

XppExceptionCode

XPointer related exception codes.

CPXML3076Definition

typedef enum XPathCompIdType {
   XvmXPathCompCXml = 1 
} XPathCompIdType;

CPXML3077

XppPrIdType

Defines XPointer processor identifiers.

CPXML3078Definition

typedef enum XppPrIdType {   XPtrPrCXml         = 1} XppPrIdType;

CPXML3079

XppLocType

Defines location types for XPointer.

CPXML3080Definition

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;

CPXML01910

Processor Interface

Table 9-2 summarizes the methods available through the Processor interface.

CPXML3081 Table 9-2 Summary of Processor Methods; XPointer Package

Function	Summary
getProcessorId()	Get processor's Id.
process()	Evaluate XPointer expression against given document.

CPXML3082

getProcessorId()

Get Processor Id.

CPXML3083Syntax

virtual XppPrIdType getProcessorId() const = 0;

CPXML3084Returns

(XppPrIdType) Processor's Id

CPXML3085

process()

Evaluates XPointer expression against given document and returns result XPointer location set object.

CPXML3086Syntax

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

CPXML3087Returns

(XppLocSet*) XPath object

CPXML01920

XppException Interface

Table 9-3 summarizes the methods available through the XPPException interface.

CPXML3088 Table 9-3 Summary of XppException Methods; Package XPointer

Function	Summary
getCode()	Get Oracle XML error code embedded in the exception.
getMesLang()	Get current language (encoding) of error messages.
getMesLang()	Get Oracle XML error message.
getXppCode()	Get XPointer exception code embedded in the exception.

CPXML3089

getCode()

Virtual member function inherited from XmlException.

CPXML3090Syntax

virtual unsigned getCode() const = 0;

CPXML3091Returns

(unsigned) numeric error code (0 on success)

CPXML3092

getMesLang()

Virtual member function inherited from XmlException.

CPXML3093Syntax

virtual oratext* getMesLang() const = 0;

CPXML3094Returns

(oratext*) Current language (encoding) of error messages

CPXML3095

getMessage()

Virtual member function inherited from XmlException.

CPXML3096Syntax

virtual oratext* getMessage() const = 0;

CPXML3097Returns

(oratext *) Error message

CPXML3098

getXppCode()

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.

CPXML3099Syntax

virtual XppExceptionCode getXppCode() const = 0;

CPXML3100Returns

(XppExceptionCode) exception code

CPXML01930

XppLocation Interface

Table 9-4 summarizes the methods available through the XppLocation interface.

CPXML3101 Table 9-4 Summary of XppLocation Methods; XPointer Package

Function	Summary
getLocType()	Get the location type.
getNode()	Get the node.
getRange()	Get range.

CPXML3102

getLocType()

Get the location type.

CPXML3103Syntax

XppLocType getLocType() const;

CPXML3104

getNode()

Get the node.

CPXML3105Syntax

Node* getNode() const;

CPXML3106

getRange()

Get range.

CPXML3107Syntax

Range< Node>* getRange() const;

CPXML01940

XppLocSet Interface

Table 9-5 summarizes the methods available through the XppLocSet interface.

CPXML3108 Table 9-5 Summary of XppLocSet Methods; XPointer Package

Function	Summary
getItem()	Get item given its index.
getSize()	Get location set size.

CPXML3109

getItem()

Returns a reference to the item.

CPXML3110Syntax

XppLocation< Node>* getItem(
   ub4 index) const;

Parameter	Description
index	index of an item

CPXML3111Returns

(XppLocation*) reference to the item

CPXML3112

getSize()

The size of the node set.

CPXML3113Syntax

ub4 getSize() const;

CPXML3114Returns

(ub4) node set size