Skip Headers
Oracle® Database XML C++ API Reference
11g Release 2 (11.2)
Part Number E10771-01
Go to Documentation Home
Home		 Go to Book List
Book List		 Go to Table of Contents
Contents		 Go to Index
Index		 Go to Master Index
Master Index		 Go to Feedback page
Contact Us
Go to previous page
Previous		 Go to next page
Next
PDF · Mobi · ePub
CPXML02000

10 Package Xsl APIs for C++

Xsl package contains XSLT related types and interfaces.

This chapter contains these sections:

See Also:

CPXML02005

Xsl Datatypes

Table 10-1 summarizes the datatypes of the Xsl package.

CPXML3115Table 10-1 Summary of Datatypes; Xsl Package

Datatype Description

XslCompIdType

Defines XSL compiler identifiers.

XslExceptionCode

Defines XSLT related exceptions.

XslTrIdType

Defines XSL transformer identifiers.

CPXML3116

XslCompIdType

Defines XSL compiler identifiers.

CPXML3117Definition

typedef enum XslCompIdType {
   XvmCompCXml = 1
} XslCompIdType;
CPXML3118

XslExceptionCode

Defines XSLT related exceptions.

CPXML3119Definition

typedef typedef enum XslExceptionCode {
   XSL_UNDEFINED_ERR = 0,
   XSL_OTHER_ERR = 1 
} XslExceptionCode;
CPXML3120

XslTrIdType

Defines XSL transformer identifiers.

CPXML3121Definition

typedef enum XslTrIdType {
   XslTrCXml         = 1,
   XvmTrCXml         = 2
} XslTrIdType;
CPXML02010

Compiler Interface

Table 10-2 summarizes the methods available through the Compiler interface.

CPXML3122Table 10-2 Summary of Compiler Methods; Xsl Package

Function Summary

compile()

Compile Xsl and return its compiled binary representation.

getCompilerId()

Get compiler's Id.

getLength()

Get length of compiled XSL document.

CPXML3123

compile()

Compiles Xsl and returns its compiled binary representation.

CPXML3124Syntax

virtual ub2* compile(
   InputSource* isrc_ptr)
throw (XslException) = 0;
Parameter Description 
isrc_ptr
Xsl document

CPXML3125Returns

(InputSource) Xsl document in compiled binary representation

CPXML3126

getCompilerId()

Get the compiler Id.

CPXML3127Syntax

virtual XslCompIdType getCompilerId() const = 0;

CPXML3128Returns

(XslCompIdType) Compiler's Id

CPXML3129

getLength()

Returns length of compiled XSL document

CPXML3130Syntax

virtual ub4 getLength( 
   ub2* binxsl_ptr)
throw (XslException) = 0;
Parameter Description 
binxsl_ptr
compiled Xsl document

CPXML3131Returns

(ub4) length of the document

CPXML02020

CompTransformer Interface

Table 10-3 summarizes the methods available through the CompTransformer interface.

CPXML3132Table 10-3 Summary of CompTransformer Methods; Xsl Package

Function Summary

getTransformerId()

Get transformer's Id.

setBinXsl()

Set compiled Xsl.

setSAXHandler()

Set SAX handler.

setXSL()

Set XSLT document for this transformer.

transform()

Transform the document.

CPXML3133

getTransformerId()

Get transformer's id.

CPXML3134Syntax

virtual XslTrIdType getTransformerId() const = 0;

CPXML3135Returns

(XslTrIdType) Transformer's Id

CPXML3136

setBinXsl()

Sets compiled Xsl.

CPXML3137Syntax

virtual void setBinXsl (
   ub2* binxsl_ptr)
throw (XslException) = 0;
Parameter Description 
binxsl_ptr
compiled Xsl document

CPXML3138

setSAXHandler()

Inherited from Transformer.

CPXML3139Syntax

virtual void setSAXHandler(
   SAXHandlerRoot* hdlr_ptr) = 0;
Parameter Description 
hdlr_ptr
SAX handler pointer

CPXML3140

setXSL()

Set XSLT document for this transformer. Should be called before the transform member function is called. It is inherited from Transform.

CPXML3141Syntax

virtual void setXSL (
   InputSource* isrc_ptr)
throw (XslException) = 0;
Parameter Description 
isrc_ptr
instance document to process

CPXML3142

transform()

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

CPXML3143Returns

(DocumentRef) document tree of new document

CPXML02030

Transformer Interface

Table 10-4 summarizes the methods available through the Transformer interface.

CPXML3144Table 10-4 Summary of Transformer Methods; Xsl Package

Function Summary

getTransformerId()

Get transformer's Id.

setSAXHandler()

Set SAX handler.

setXSL()

Set XSLT document for this transformer.

transform()

Transform the document and return SAX events.

CPXML3145

getTransformerId()

Gets transformer's id.

CPXML3146Syntax

virtual XslTrIdType getTransformerId() const = 0;

CPXML3147Returns

(XslTrIdType) Transformer's Id

CPXML3148

setSAXHandler()

Set SAX handler.

CPXML3149Syntax

virtual void setSAXHandler( 
   SAXHandlerRoot* hdlr_ptr) = 0;
Parameter Description 
hdlr_ptr
SAX handler pointer

CPXML3150

setXSL()

Set XSLT document for this transformer. Should be called before the transform member function is called.

CPXML3151Syntax

virtual void setXSL (
   InputSource* isrc_ptr)
throw (XslException) = 0;
Parameter Description 
isrc_ptr
instance document to process

CPXML3152

transform()

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

CPXML3153Returns

(DocumentRef) document tree of new document

CPXML02040

XSLException Interface

Table 10-5 summarizes the methods available through the XSLException interface.

CPXML3154Table 10-5 Summary of XSLException Methods; Xsl Package

Function Summary

getCode()

Get Oracle XML error code embedded in the exception.

getMesLang()

Get current language (encoding) of error messages.

getMessage()

Get Oracle XML error message.

getXslCode()

Defines a prototype for implementation.

CPXML3155

getCode()

Gets Oracle XML error code embedded in the exception. Virtual member function inherited from XmlException.

CPXML3156Syntax

virtual unsigned getCode() const = 0;

CPXML3157Returns

(unsigned) numeric error code (0 on success)

CPXML3158

getMesLang()

Virtual member function inherited from XmlException.

CPXML3159Syntax

virtual oratext* getMesLang() const = 0;

CPXML3160Returns

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

CPXML3161

getMessage()

Virtual member function inherited from XmlException

CPXML3162Syntax

virtual oratext* getMessage() const = 0;

CPXML3163Returns

(oratext *) Error message

CPXML3164

getXslCode()

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.

CPXML3165Syntax

virtual XslExceptionCode getXslCode() const = 0;

CPXML3166Returns

(XslExceptionCode) exception code

Reader Comment

   

Comments, corrections, and suggestions are forwarded to authors every week. By submitting, you confirm you agree to the terms and conditions. Use the OTN forums for product questions. For support or consulting, file a service request through My Oracle Support.

Go to previous page
Previous		 Go to next page
Next
Go to Documentation Home
Home		 Go to Book List
Book List		 Go to Table of Contents
Contents		 Go to Index
Index		 Go to Master Index
Master Index		 Go to Feedback page
Contact Us
Hide Navigation

Quick Lookup

Database Library · Master Index · Master Glossary · Book List · Data Dictionary · SQL Keywords · Initialization Parameters · Advanced Search · Error Messages

Main Categories

This Page

  • Xsl Datatypes
    • XslCompIdType
    • XslExceptionCode
    • XslTrIdType
  • Compiler Interface
    • compile()
    • getCompilerId()
    • getLength()
  • CompTransformer Interface
    • getTransformerId()
    • setBinXsl()
    • setSAXHandler()
    • setXSL()
    • transform()
  • Transformer Interface
    • getTransformerId()
    • setSAXHandler()
    • setXSL()
    • transform()
  • XSLException Interface
    • getCode()
    • getMesLang()
    • getMessage()
    • getXslCode()

This Document

New and changed documents:
RSS Feed HTML RSS Feed PDF