Functions | Datatypes

Package XPath

XPath is the namespace (sub-space of OracleXml) for XPath processing related types and interfaces.

Member Function Index
Interface NodeSet (Interface one-line doc)
Interface XPathException (Exceptions for XPath compilers & processors)
Interface XPathObject ( interface for XPath 1.0 objects)
Interface XPath_CompProcessor (Extended XPath Processor)
Interface XPath_Compiler (XPath compiler into binary representation)
Interface XPath_Processor (basic XPath Processsor)

Member Function Index

Interface	Function	Description
`NodeSet`	`getNode`	Get node given its index
`NodeSet`	`getSize`	Get node set size
`XPathException`	`getCode`	Get Oracle XML error code embedded in the exception
`XPathException`	`getMesLang`	Get current language (encoding) of error messages
`XPathException`	`getMessage`	Get Oracle XML error message
`XPathException`	`getXPathCode`	Get XPath exception code embedded in the exception
`XPathObject`	`XPathObject`	Copy constructor
`XPathObject`	`getNodeSet`
`XPathObject`	`getObjBoolean`
`XPathObject`	`getObjNumber`
`XPathObject`	`getObjString`
`XPathObject`	`getObjType`
`XPath_CompProcessor`	`getProcessorId`	Get processor's Id
`XPath_CompProcessor`	`process`	Evaluate XPath expression against given document
`XPath_CompProcessor`	`processWithBinXPath`	Evaluate compiled XPath expression against given document
`XPath_Compiler`	`compile`	Compile XPath and return its compiled binary representation.
`XPath_Compiler`	`getCompilerId`	Get compiler's Id
`XPath_Processor`	`getProcessorId`	Get processor's Id
`XPath_Processor`	`process`	Evaluate XPath expression against given document

Interface NodeSet (Interface one-line doc)

Member Function Index

Function	Description
getNode	Get node given its index
getSize	Get node set size

Interface XPathException (Exceptions for XPath compilers & processors)

Member Function Index

Function	Description
getCode	Get Oracle XML error code embedded in the exception
getMesLang	Get current language (encoding) of error messages
getMessage	Get Oracle XML error message
getXPathCode	Get XPath exception code embedded in the exception

Interface XPathObject ( interface for XPath 1.0 objects)

Member Function Index

Function	Description
XPathObject	Copy constructor
getNodeSet
getObjBoolean
getObjNumber
getObjString
getObjType

Interface XPath_CompProcessor (Extended XPath Processor)

Member Function Index

Function	Description
getProcessorId	Get processor's Id
process	Evaluate XPath expression against given document
processWithBinXPath	Evaluate compiled XPath expression against given document

Interface XPath_Compiler (XPath compiler into binary representation)

Member Function Index

Function	Description
compile	Compile XPath and return its compiled binary representation.
getCompilerId	Get compiler's Id

Interface XPath_Processor (basic XPath Processsor)

Member Function Index

Function	Description
getProcessorId	Get processor's Id
process	Evaluate XPath expression against given document

getNode

Name getNode

Interface NodeSet

Purpose Get node given its index

Prototype NodeRef< Node>* getNode( ub4 idx) const;

Arguments

idx (IN) index of the node in the set

Returns (NodeRef) reference to the node

Description

Returns a reference to the node

getSize

Name	`getSize`
Interface	NodeSet
Purpose	Get node set size
Prototype	`ub4 getSize() const;`
Arguments	`void`
Returns	`(ub4)` node set size
Description	The size of the node set

getCode

Name	`getCode`
Interface	XPathException
Purpose	Get Oracle XML error code embedded in the exception
Prototype	`// virtual unsigned getCode() const = 0;`
Arguments	`void`
Returns	`(unsigned)` numeric error code (0 on success)
Description	Virtual member function inherited from XMLException

getMesLang

Name	`getMesLang`
Interface	XPathException
Purpose	Get current language (encoding) of error messages
Prototype	`// virtual oratext* getMesLang() const = 0;`
Arguments	`void`
Returns	`(oratext*)` Current language (encoding) of error messages
Description	Virtual member function inherited from XMLException

getMessage

Name	`getMessage`
Interface	XPathException
Purpose	Get Oracle XML error message
Prototype	`// virtual oratext* getMessage() const = 0;`
Arguments	`void`
Returns	`(oratext *)` Error message
Description	Virtual member function inherited from XMLException

getXPathCode

Name	`getXPathCode`
Interface	XPathException
Purpose	Get XPath exception code embedded in the exception
Prototype	`virtual XPathExceptionCode getXPathCode() const = 0; };`
Arguments	`void`
Returns	`(XPathExceptionCode)` exception code
Description	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

XPathObject

Name XPathObject

Interface XPathObject

Purpose Copy constructor

Prototype XPathObject( XPathObject< Node>&);

Arguments

(XPathObject&) (referene) referene to the object to be copied

Returns (XPathObject) new object

Description

Copies the object

getNodeSet

Name	`getNodeSet`
Interface	XPathObject
Purpose
Prototype	`NodeSet< Node>* getNodeSet() const;`
Arguments	`void`
Returns
Description

getObjBoolean

Name	`getObjBoolean`
Interface	XPathObject
Purpose
Prototype	`boolean getObjBoolean() const;`
Arguments	`void`
Returns
Description

getObjNumber

Name	`getObjNumber`
Interface	XPathObject
Purpose
Prototype	`double getObjNumber() const;`
Arguments	`void`
Returns
Description

getObjString

Name	`getObjString`
Interface	XPathObject
Purpose
Prototype	`oratext* getObjString() const;`
Arguments	`void`
Returns
Description

getObjType

Name	`getObjType`
Interface	XPathObject
Purpose
Prototype	`XPathObjType getObjType() const;`
Arguments	`void`
Returns
Description

getProcessorId

Name	`getProcessorId`
Interface	XPath_CompProcessor
Purpose	Get processor's Id
Prototype	`// virtual XPathPrIdType getProcessorId() const = 0;`
Arguments	`void`
Returns	`(XPathPrIdType)` Processor's Id
Description

process

Name process

Interface XPath_CompProcessor

Purpose Evaluate XPath expression against given document

Prototype // virtual XPathObject< Node>* process (InputSource* isrc_ptr, // oratext* xpath_exp) // throw (XPathException) = 0;

Arguments

`isrc_ptr`	(IN)	instance document to process
`xpath_exp`	(IN)	XPath expression

Returns (XPathGenObject*) XPath object

Description Inherited from Processor

processWithBinXPath

Name processWithBinXPath

Interface XPath_CompProcessor

Purpose Evaluate compiled XPath expression against given document

Prototype virtual XPathObject< Node>* processWithBinXPath ( InputSource* isrc_ptr, ub2* bin_xpath) throw (XPathException) = 0;

Arguments

`isrc_ptr`	(IN)	instance document to process
`bin_xpath`	(IN)	compiled xpath expression

Returns (XPathGenObject*) XPath object

Description

Evaluates compiled XPath expression against given document

compile

Name compile

Interface XPath_Compiler

Purpose Compile XPath and return its compiled binary representation.

Prototype virtual ub2* compile (oratext* xpath_exp) throw (XPathException) = 0;

Arguments

xpath_exp (IN) XPath expression

Returns (ub2) XPath expression in compiled binary representation

Description

Compiles XPath and returns its compiled binary representation

getCompilerId

Name	`getCompilerId`
Interface	XPath_Compiler
Purpose	Get compiler's Id
Prototype	`virtual XPathCompIdType getCompilerId() const = 0;`
Arguments	`void`
Returns	`(XPathCompIdType)` Compiler's Id
Description

getProcessorId

Name	`getProcessorId`
Interface	XPath_Processor
Purpose	Get processor's Id
Prototype	`virtual XPathPrIdType getProcessorId() const = 0;`
Arguments	`void`
Returns	`(XPathPrIdType)` Processor's Id
Description

process

Name process

Interface XPath_Processor

Purpose Evaluate XPath expression against given document

Prototype virtual XPathObject< Node>* process (InputSource* isrc_ptr, oratext* xpath_exp) throw (XPathException) = 0;

Arguments

`isrc_ptr`	(IN)	instance document to process
`xpath_exp`	(IN)	XPath expression

Returns (XPathGenObject*) XPath object

Description Evaluates XPath expression against given document and returns result XPath object