Packages: All | Ctx | Dom | IO | OracleXml | Parser | Tools | XPath | XPointer | Xsl Functions | Datatypes

Package XPointer

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


Member Function Index

InterfaceFunctionDescription
XPointer_Processor  getProcessorId  Get processor's Id
XPointer_Processor  process  Evaluate XPointer expression against given document
XppException  getCode  Get Oracle XML error code embedded in the exception
XppException  getMesLang  Get current language (encoding) of error messages
XppException  getMessage  Get Oracle XML error message
XppException  getXppCode  Get XPointer exception code embedded in the exception
XppLocSet  getItem  Get item given its index
XppLocSet  getSize  Get location set size
XppLocation  getLocType 
XppLocation  getNode 
XppLocation  getRange 


Interface XPointer_Processor (basic XPointer Processsor)

Member Function Index

FunctionDescription
getProcessorId Get processor's Id
process Evaluate XPointer expression against given document


Interface XppException (Exceptions for XPointer processors)

Member Function Index

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


Interface XppLocSet (Location set interface)

Member Function Index

FunctionDescription
getItem Get item given its index
getSize Get location set size


Interface XppLocation ( interface for XPointer locations)

Member Function Index

FunctionDescription
getLocType
getNode
getRange

getProcessorId

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

process

Name process
Interface XPointer_Processor
Purpose Evaluate XPointer expression against given document
Prototype   virtual XppLocSet< Node>* process (InputSource* isrc_ptr,
    oratext* xpp_exp)
                                      throw (XppException) = 0;
Arguments
isrc_ptr  (IN)  instance document to process
xpp_exp  (IN)  XPointer expression
Returns (XppLocSet*) XPath object
Description Evaluates XPointer expression against given document and returns result XPointer location set object

getCode

Name getCode
Interface XppException
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 XppException
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 XppException
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

getXppCode

Name getXppCode
Interface XppException
Purpose Get XPointer exception code embedded in the exception
Prototype   virtual XppExceptionCode getXppCode() const = 0;
};
Arguments void
Returns (XppExceptionCode) exception code
Description 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

getItem

Name getItem
Interface XppLocSet
Purpose Get item given its index
Prototype   XppLocation< Node>* getItem( ub4 index) const;
Arguments void
Returns (XppLocation*) reference to the item
Description Returns a reference to the item

getSize

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

getLocType

Name getLocType
Interface XppLocation
Purpose
Prototype   XppLocType getLocType() const;
Arguments void
Returns
Description

getNode

Name getNode
Interface XppLocation
Purpose
Prototype   Node* getNode() const;
Arguments void
Returns
Description

getRange

Name getRange
Interface XppLocation
Purpose
Prototype   Range< Node>* getRange() const;
Arguments void
Returns
Description