FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoXslTransformer Class Reference

#include <Transformer.h>

Inherits FdoDisposable.

Inherited by FdoXslTransformerXalan.

Inheritance diagram for FdoXslTransformer:

[legend]
List of all members.

Detailed Description

FdoXslTransformer provides a way to execute an XSL stylesheet on an XML document.

Definition at line 27 of file Transformer.h.


Public Member Functions

FDO_API_COMMON FdoXmlReaderGetInDoc ()
 Gets the document being transformed.
FDO_API_COMMON FdoIoTextWriterGetLog ()
 Gets the logging object.
FDO_API_COMMON FdoXmlWriterGetOutDoc ()
 Gets the output document.
FDO_API_COMMON FdoDictionaryGetParameters ()
 Gets the list of parameters that will be passed to the stylesheet by Transform(). The caller can add parameters to this list or modify/delete existing parameters. The parameter list is empty when this class is constructed. Parameter values must be in XPath syntax. Therefore, literal values must be enclosed in single quotes.
FDO_API_COMMON FdoXmlReaderGetStylesheet ()
 Gets the XSL Stylesheet.
FDO_API_COMMON void SetInDoc (FdoXmlReader *inDoc)
 Sets the document to transform.
FDO_API_COMMON void SetLog (FdoIoTextWriter *log)
 Sets the logging object.
FDO_API_COMMON void SetOutDoc (FdoXmlWriter *outDoc)
 Sets the output document.
FDO_API_COMMON void SetStylesheet (FdoXmlReader *stylesheet)
 Sets the XSL stylesheet.
virtual FDO_API_COMMON void Transform ()=0
 Performs the transformation.

Static Public Member Functions

FDO_API_COMMON FdoXslTransformerCreate (FdoXmlReader *inDoc=NULL, FdoXmlReader *stylesheet=NULL, FdoXmlWriter *outDoc=NULL, FdoIoTextWriter *log=NULL)
 Constructs an XSL Transformer object.

Protected Member Functions

 FdoXslTransformer (FdoXmlReader *inDoc=NULL, FdoXmlReader *stylesheet=NULL, FdoXmlWriter *outDoc=NULL, FdoIoTextWriter *log=NULL)
 DOXYGEN-IGNORE
virtual ~FdoXslTransformer (void)

Constructor & Destructor Documentation

FdoXslTransformer::FdoXslTransformer FdoXmlReader inDoc = NULL,
FdoXmlReader stylesheet = NULL,
FdoXmlWriter outDoc = NULL,
FdoIoTextWriter log = NULL
[protected]
 

DOXYGEN-IGNORE

virtual FdoXslTransformer::~FdoXslTransformer void   )  [inline, protected, virtual]
 

Definition at line 152 of file Transformer.h.


Member Function Documentation

FDO_API_COMMON FdoXslTransformer* FdoXslTransformer::Create FdoXmlReader inDoc = NULL,
FdoXmlReader stylesheet = NULL,
FdoXmlWriter outDoc = NULL,
FdoIoTextWriter log = NULL
[static]
 

Constructs an XSL Transformer object.

Parameters:
inDoc Input the XML document to transform.
stylesheet Input the XSL stylesheet with transformation instructions.
outDoc Output the transformed XML document.
Warning:
The transformed document is not completely written until 'outDoc' and this transformer are destroyed by releasing all references to them. Therefore, these objects must be destroyed before reading back the transformed document.
Parameters:
log Input the logging object which captures messages and warnings.
Returns:
Returns FdoXslTransformer

Reimplemented in FdoXslTransformerXalan.

FDO_API_COMMON FdoXmlReader* FdoXslTransformer::GetInDoc  ) 
 

Gets the document being transformed.

Returns:
Returns the input document.

FDO_API_COMMON FdoIoTextWriter* FdoXslTransformer::GetLog  ) 
 

Gets the logging object.

Returns:
Returns the logging object

FDO_API_COMMON FdoXmlWriter* FdoXslTransformer::GetOutDoc  ) 
 

Gets the output document.

Returns:
Returns the out document

FDO_API_COMMON FdoDictionary* FdoXslTransformer::GetParameters  ) 
 

Gets the list of parameters that will be passed to the stylesheet by Transform(). The caller can add parameters to this list or modify/delete existing parameters. The parameter list is empty when this class is constructed. Parameter values must be in XPath syntax. Therefore, literal values must be enclosed in single quotes.

Returns:
Returns the parameter list.

FDO_API_COMMON FdoXmlReader* FdoXslTransformer::GetStylesheet  ) 
 

Gets the XSL Stylesheet.

Returns:
Returns the stylesheet.

FDO_API_COMMON void FdoXslTransformer::SetInDoc FdoXmlReader inDoc  ) 
 

Sets the document to transform.

Parameters:
inDoc Input the XML document to transform.

FDO_API_COMMON void FdoXslTransformer::SetLog FdoIoTextWriter log  ) 
 

Sets the logging object.

Parameters:
log The logging object which captures messages and warnings.

FDO_API_COMMON void FdoXslTransformer::SetOutDoc FdoXmlWriter outDoc  ) 
 

Sets the output document.

Parameters:
outDoc Input the output document
Warning:
The output document is not completely written until outDoc and this transformer are destroyed by releasing all references to them.

FDO_API_COMMON void FdoXslTransformer::SetStylesheet FdoXmlReader stylesheet  ) 
 

Sets the XSL stylesheet.

Parameters:
stylesheet Input the stylesheet

virtual FDO_API_COMMON void FdoXslTransformer::Transform  )  [pure virtual]
 

Performs the transformation.

Implemented in FdoXslTransformerXalan.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.