This is a simple C++ interface for some common usage patterns. More...
#include <XalanTransformer.hpp>
Collaboration diagram for XalanTransformer:
This is a simple C++ interface for some common usage patterns.
It's the user's responsibility to call initialize and terminate for Xerces and Xalan before creating and after deleting any XalanTransformer instances.
|
|
|
|
|
|
|
|
|
Enums to determine whether or not run-time escaping of URLs has been set.
eEscapeURLsDefault | |
eEscapeURLsNo | |
eEscapeURLsYes |
|
Enums to determine whether or not run-time omission of the META tag has been set.
eOmitMETATagDefault | |
eOmitMETATagNo | |
eOmitMETATagYes |
|
|
|
Clean up the ICU, if ICU integration is enabled.
This should be called only once per process after calling XalanTransformer::terminate() and XMLPlatformUtils::Terminate.
This must only be done if the ICU will no longer be used by the process, since the ICU will no longer be in a usable state. See the ICU documentation for more details.
This is handy when using leak-detection software, as all static data allocated by the ICU is freed.
|
Add a TraceListener instance.
TraceListeners instances are preserved between calls to transform(), so they will be called until they are removed.
theTraceListener | The instance to add. |
|
Creates a compiled stylesheet.
The input source can be a file name, a stream or a root node. The XalanTransformer instance owns the XalanCompiledStylesheet instance and will delete it when the XalanTransformer instance goes out of scope, or you explicitly call destroyStylesheet(). You must not delete the instance yourself.
theStylesheetSource | input source |
theCompiledStylesheet | a reference to a pointer to a XalanCompileStylesheet. |
|
Create a document builder.
Using the document builder, you can construct a document using SAX2 interfaces. The XalanTransformer instance owns the document builder and will delete it when the XalanTransformer instance goes out of scope, or you explicitly call destroyDocumentBuilder(). You must not delete the instance yourself.
|
Destroy a document builder created by a previous call to createDocumentBuilder().
Passing a pointer that is not created by a call to createDocumentBuilder() can result in undefined behavior.
theDocumentBuilder | The document builder to destroy. |
|
Destroy a parsed source created by a previous call to parseSource().
theParsedSource | The XalanParsedSource instance to destroy. |
|
Destroy a XalanCompiledStylesheet instance created by a previous call to compileStylesheet().
theStylesheet | The instance to destroy. |
|
This method returns the installed entity resolver.
|
This method returns the installed error handler.
|
Get the value for run-time escaping of URLs.
This can override the property specified by the stylesheet. The default behavior is to honor the property in the stylesheet.
|
This method returns the location for an external schema document for parsing.
|
This method returns the location for an external schema document for parsing.
|
Get the current number of spaces to indent.
|
Returns the last error that occurred as a result of calling transform.
|
Get the value for run-time omission of URLs.
This can override the property specified by the stylesheet. The default behavior is to honor the property in the stylesheet.
|
This method returns the installed ProblemListener instance.
|
Set a flag to indicate whether or not the source file(s) for the transformation will be validated.
fValue | the new value for the flag. |
|
Get the current warning stream ostream instance.
|
Initialize Xalan.
Should be called only once per process before creating any instances of XalanTransformer.
|
Install an external function in the local space.
theNamespace | The namespace for the functionl |
functionName | The name of the function. |
function | The function to install. |
|
Install an external function in the global space.
theNamespace | The namespace for the functionl |
functionName | The name of the function. |
function | The function to install. |
|
Parse a source XML document.
The input source can be a file name, a stream or a root node. The XalanTransformer instance owns the XalanParsedSource instance and will delete it when the XalanTransformer instance goes out of scope, or you explicitly call destroyParsedSource(). You must not delete the instance yourself.
theInputSource | input source |
theParsedSource | a reference to a pointer to a XalanParsedSource. |
useXercesDOM | input use default or xerces DOM source tree |
|
Remove a TraceListener instance.
theTraceListener | The instance to remove. |
|
Remove all TraceListener instances.
|
This method installs the user-specified entity resolver.
It allows applications to trap and redirect calls to external entities.
handler | A pointer to the entity resolver to be called when the parser comes across references to entities in the XML file. |
|
This method installs the user-specified error handler.
handler | A pointer to the error handler to be called upon error. |
|
Set the value for run-time escaping of URLs.
This can override the property specified by the stylesheet. The default behavior is to honor the property in the stylesheet.
value | The value of the enum |
|
This method sets the location for an external schema document for parsing.
location | A string representing the location of the external schema document |
|
This method sets the location for an external schema document for parsing.
location | A string representing the location of the external schema document |
|
Set the current number of spaces to indent.
indentAmount | The number of spaces to indent. Use -1 for the default amount. |
|
Get the value for run-time omission of URLs.
This can override the property specified by the stylesheet. The default behavior is to honor the property in the stylesheet.
value | The value of the enum |
|
This method installs the user-specified ProblemListener instance.
handler | A pointer to the ProblemListener to be called when a problem occurs. |
|
Set a top-level stylesheet parameter.
This value can be evaluated via xsl:param-variable. These values are cleared after a call to transform().
key | name of the param |
expression | expression that will be evaluated |
|
Set a top-level stylesheet parameter.
This value can be evaluated via xsl:param-variable. These values are cleared after a call to transform().
key | name of the param |
expression | expression that will be evaluated |
|
Set a flag to indicate whether or not the source file(s) for the transformation will be validated.
fValue | the new value for the flag. |
|
Set the ostream instance for reporting warnings and messages.
The default is std::cerr. If set to null, no warnings or messages will be written.
theStream | A pointer to the ostream instance. |
|
Terminate Xalan.
Should be called only once per process after deleting all instances of XalanTransformer.
This is handy when using leak-detection software, as all static data allocated by Xalan is freed.
|
Transform will apply the stylesheet provided as a PI in the XML of the input source and write the transformation result to a callback function in pre-allocated blocks.
The input source can be a file name, a stream or a root node. Upon termination, Xalan releases any allocated memory. Data passed to the callback is not guaranteed to be null terminated.
theInputSource | input source |
theOutputHandle | void pointer passed through to callback. |
theOutputHandler | a user defined callback function. |
theFlushHandler | an optional user-defined callback function. |
|
Transform will apply the compiled stylesheet to the source and write the transformation result to a callback function in pre-allocated blocks.
The input source can be a file name, a stream or a root node. Upon termination, Xalan releases any allocated memory. Data passed to the callback is not guaranteed to be null terminated.
theParsedSource | Parsed source instance |
theCompiledStylesheet | pointer to a compiled stylesheet. Must not be null. |
theOutputHandle | void pointer passed through to callback. |
theOutputHandler | a user defined callback function. |
theFlushHandler | An optional user-defined callback function. |
|
Transform will apply the compiled stylesheet to the input source and write the transformation output to the target.
The input source and result target can be a file name, a stream or a root node.
theInputSource | input source |
theCompiledStylesheet | pointer to a compiled stylesheet. Must not be null. |
theResultTarget | output source |
|
Transform will apply the stylesheet source to the input source and write the transformation result to a callback function in pre-allocated blocks.
The input source can be a file name, a stream or a root node. Upon termination, Xalan releases any allocated memory. Data passed to the callback is not guaranteed to be null terminated.
theInputSource | input source |
theStylesheetSource | stylesheet source |
theOutputHandle | void pointer passed through to callback. |
theOutputHandler | a user defined (callback) function. |
theFlushHandler | (optional) a user defined (callback) function. |
|
Transform will apply the stylesheet provided as a PI in the XML of the input source and write the transformation output to the target.
The input source and result target can be a file name, a stream or a root node.
theInputSource | input source |
theResultTarget | output source tree |
|
Transform will apply the stylesheet source to the input source and write the transformation output to the target.
The input source and result target can be a file name, a stream or a root node.
theInputSource | input source |
theStylesheetSource | stylesheet source |
theResultTarget | output source |
|
Transform will apply the compiled stylesheet to the parsed xml source and write the transformation output to the target.
theParsedXML | the parsed input source |
theCompiledStylesheet | pointer to a compiled stylesheet. Must not be null. |
theResultTarget | output source |
|
Transform will apply the stylesheet source to the parsed xml source and write the transformation output to the target.
theParsedXML | the parsed input source |
theStylesheetSource | stylesheet source |
theResultTarget | output source |
|
Uninstall an external local function.
theNamespace | The namespace for the function |
functionName | The name of the function. |
|
Uninstall an external global function.
theNamespace | The namespace for the function |
functionName | The name of the function. |
|
The documentation for this class was generated from the following file:
Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.
![]() |
Xalan-C++ XSLT Processor Version 1.4 |
|