Functions | Datatypes

Package Xsl

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

Member Function Index
Interface CompTransformer (Extended XSLT Processor)
Interface Transformer (basic XSLT Processor)
Interface XslException (Exceptions for XSL compilers & transformers)
Interface Xsl_Compiler (Xsl compiler into binary representation)

Member Function Index

Interface	Function	Description
`CompTransformer`	`getTransformerId`	Get transformer's Id
`CompTransformer`	`setBinXsl`	Set compiled Xsl
`CompTransformer`	`setSAXHandler`	Set SAX handler
`CompTransformer`	`setXSL`	Set XSLT document for this transformer
`CompTransformer`	`transform`	Transform the document and return DOM
`CompTransformer`	`transform`	Transform the document and return SAX events
`Transformer`	`getTransformerId`	Get transformer's Id
`Transformer`	`setSAXHandler`	Set SAX handler
`Transformer`	`setXSL`	Set XSLT document for this transformer
`Transformer`	`transform`	Transform the document and return DOM
`Transformer`	`transform`	Transform the document and return SAX events
`XslException`	`getCode`	Get Oracle XML error code embedded in the exception
`XslException`	`getMesLang`	Get current language (encoding) of error messages
`XslException`	`getMessage`	Get Oracle XML error message
`XslException`	`getXslCode`	Get XSL exception code embedded in the exception
`Xsl_Compiler`	`compile`	Compile Xsl and return its compiled binary representation.
`Xsl_Compiler`	`getCompilerId`	Get compiler's Id
`Xsl_Compiler`	`getLength`	Get length of compiled XSL document

Interface CompTransformer (Extended XSLT Processor)

Member Function Index

Function	Description
getTransformerId	Get transformer's Id
setBinXsl	Set compiled Xsl
setSAXHandler	Set SAX handler
setXSL	Set XSLT document for this transformer
transform	Transform the document and return DOM
transform	Transform the document and return SAX events

Interface Transformer (basic XSLT Processor)

Member Function Index

Function	Description
getTransformerId	Get transformer's Id
setSAXHandler	Set SAX handler
setXSL	Set XSLT document for this transformer
transform	Transform the document and return DOM
transform	Transform the document and return SAX events

Interface XslException (Exceptions for XSL compilers & transformers)

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
getXslCode	Get XSL exception code embedded in the exception

Interface Xsl_Compiler (Xsl compiler into binary representation)

Member Function Index

Function	Description
compile	Compile Xsl and return its compiled binary representation.
getCompilerId	Get compiler's Id
getLength	Get length of compiled XSL document

getTransformerId

Name	`getTransformerId`
Interface	CompTransformer
Purpose	Get transformer's Id
Prototype	`// virtual XslTrIdType getTransformerId() const = 0;`
Arguments	`void`
Returns	`(XslTrIdType)` Transformer's Id
Description

setBinXsl

Name setBinXsl

Interface CompTransformer

Purpose Set compiled Xsl

Prototype virtual void setBinXsl (ub2* binxsl_ptr) throw (XslException) = 0;

Arguments

binxsl_ptr (IN) compiled Xsl

Returns (void)

Description

Sets compiled Xsl

setSAXHandler

Name setSAXHandler

Interface CompTransformer

Purpose Set SAX handler

Prototype // virtual void setSAXHandler( SAXHandlerRoot* hdlr_ptr) = 0;

Arguments

hdlr_ptr (IN) SAX handler pointer

Returns (void)

Description

Inherited from Transformer

setXSL

Name setXSL

Interface CompTransformer

Purpose Set XSLT document for this transformer

Prototype // virtual void setXSL (InputSource* isrc_ptr) // throw (XslException) = 0;

Arguments

isrc_ptr (IN) instance document tp process

Returns (void)

Description

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

transform

Name transform

Interface CompTransformer

Purpose Transform the document and return DOM

Prototype // virtual NodeRef< Node>* transform( InputSource* isrc_ptr) // throw (XslException) = 0;

Arguments

`isrc_ptr`	(IN)	instance document tp process
`normalize`	(IN)	if TRUE the XSL processor normalizes the doc
`no_mod`	(IN)
`new_domimpl`	(IN)

Returns (DocumentRef) document tree of new document

Description

Inherited from Transform

transform

Name transform

Interface CompTransformer

Purpose Transform the document and return SAX events

Prototype // virtual void transform (InputSource* isrc_ptr, // SAXHandlerRoot* hdlr_ptr) // throw (XslException) = 0;

Arguments

`isrc_ptr`	(IN)	instance document to process
`hdlr_ptr`	(IN)	SAX handler pointer

Returns (void)

Description

Inherited from Transform

getTransformerId

Name	`getTransformerId`
Interface	Transformer
Purpose	Get transformer's Id
Prototype	`virtual XslTrIdType getTransformerId() const = 0;`
Arguments	`void`
Returns	`(XslTrIdType)` Transformer's Id
Description

setSAXHandler

Name setSAXHandler

Interface Transformer

Purpose Set SAX handler

Prototype virtual void setSAXHandler( SAXHandlerRoot* hdlr_ptr) = 0;

Arguments

hdlr_ptr (IN) SAX handler pointer

Returns (void)

Description

setXSL

Name setXSL

Interface Transformer

Purpose Set XSLT document for this transformer

Prototype virtual void setXSL (InputSource* isrc_ptr) throw (XslException) = 0;

Arguments

isrc_ptr (IN) instance document tp process

Returns (void)

Description

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

transform

Name transform

Interface Transformer

Purpose Transform the document and return DOM

Prototype virtual NodeRef< Node>* transform (InputSource* isrc_ptr) throw (XslException) = 0;

Arguments

`isrc_ptr`	(IN)	instance document tp process
`normalize`	(IN)	if TRUE the XSL processor normalizes the doc
`no_mod`	(IN)
`new_domimpl`	(IN)

Returns (DocumentRef) document tree of new document

Description Transforms the document and returns DOM. Throws an exception if an XSLT document is not set by a previous call to setXSL.

transform

Name transform

Interface Transformer

Purpose Transform the document and return SAX events

Prototype virtual void transform (InputSource* isrc_ptr, SAXHandlerRoot* hdlr_ptr) throw (XslException) = 0;

Arguments

`isrc_ptr`	(IN)	instance document tp process
`hdlr_ptr`	(IN)	SAX handler pointer

Returns (void)

Description

getCode

Name	`getCode`
Interface	XslException
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	XslException
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	XslException
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

getXslCode

Name	`getXslCode`
Interface	XslException
Purpose	Get XSL exception code embedded in the exception
Prototype	`virtual XslExceptionCode getXslCode() const = 0; };`
Arguments	`void`
Returns	`(XslExceptionCode)` exception code
Description	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

compile

Name compile

Interface Xsl_Compiler

Purpose Compile Xsl and return its compiled binary representation.

Prototype virtual ub2* compile( InputSource* isrc_ptr) throw (XslException) = 0;

Arguments

isrc_ptr (IN) Xsl document

Returns (InputSource) Xsl document in compiled binary representation

Description

Compiles Xsl and returns its compiled binary representation

getCompilerId

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

getLength

Name getLength

Interface Xsl_Compiler

Purpose Get length of compiled XSL document

Prototype virtual ub4 getLength( ub2* binxsl_ptr) throw (XslException) = 0;

Arguments

binxsl_ptr (IN) compiled XSL document

Returns (ub4) length of the document

Description

Returns length of compiled XSL document