Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Types | Public Member Functions

XSLTProcessor Class Reference

This is an interface for an XSLT Processor engine. More...

#include <XSLTProcessor.hpp>

Inherits ProblemListenerBase.

Inherited by XSLTEngineImpl.

Collaboration diagram for XSLTProcessor:
Collaboration graph
[legend]

List of all members.

Public Types

Public Member Functions


Detailed Description

This is an interface for an XSLT Processor engine.

It's the responsibility of the implementation of the XSLTProcessor interface, collaborating with a XMLParserLiaison, the DOM, and the XPath engine, to transform a source tree of nodes into a result tree according to instructions and templates specified by a stylesheet tree. The methods process(...) are the primary public entry points.

If you reuse the processor instance, you should call reset() between calls.

Definition at line 85 of file XSLTProcessor.hpp.


Member Typedef Documentation

typedef XalanSize_t XSLTProcessor::size_type

Definition at line 89 of file XSLTProcessor.hpp.


Constructor & Destructor Documentation

XSLTProcessor::XSLTProcessor (  ) 
virtual XSLTProcessor::~XSLTProcessor (  )  [virtual]

Member Function Documentation

virtual void XSLTProcessor::addTraceListener ( TraceListener tl  )  [pure virtual]

Add a trace listener for the purposes of debugging and diagnosis.

Parameters:
tl pointer to listener to add
virtual void XSLTProcessor::clearStylesheetParams (  )  [pure virtual]

Clear any stylesheet params.

virtual void XSLTProcessor::fireGenerateEvent ( const GenerateEvent ge  )  [pure virtual]

Fire a generate event.

Parameters:
ge generate event to fire
virtual void XSLTProcessor::fireSelectEvent ( const SelectionEvent se  )  [pure virtual]

Fire a selection event.

Parameters:
se selection event to fire
virtual void XSLTProcessor::fireTraceEvent ( const TracerEvent te  )  [pure virtual]

Fire a trace event.

Parameters:
te trace event to fire
virtual FormatterListener* XSLTProcessor::getFormatterListener (  )  const [pure virtual]

Get the current formatter listener.

Returns:
pointer to formatter listener
virtual XalanNode* XSLTProcessor::getSourceTreeFromInput ( const XSLTInputSource inputSource  )  [pure virtual]

Given an input source, get the source tree.

Parameters:
inputSource pointer to input source
Returns:
source tree
virtual const StylesheetRoot* XSLTProcessor::getStylesheetRoot (  )  const [pure virtual]

Retrieve the root stylesheet.

Returns:
pointer to root stylesheet
virtual size_type XSLTProcessor::getTraceListeners (  )  const [pure virtual]

Determine the number of trace listeners.

Returns:
number of listeners
virtual bool XSLTProcessor::getTraceSelects (  )  const [pure virtual]

If this is set to true, simple traces of template calls are made.

Returns:
true if traces made
virtual void XSLTProcessor::getUniqueNamespaceValue ( XalanDOMString theValue  )  [pure virtual]

Generate a random namespace prefix guaranteed to be unique.

Parameters:
theValue A string for returning the new prefix
virtual XMLParserLiaison& XSLTProcessor::getXMLParserLiaison (  )  const [pure virtual]

Get the XML Parser Liaison that this processor uses.

Returns:
XML parser liaison object
virtual void XSLTProcessor::problem ( eSource  source,
eClassification  classification,
const XalanDOMString msg,
const Locator *  locator,
const XalanNode sourceNode 
) [pure virtual]

Function that is called when a problem event occurs.

Parameters:
source Either eXMLParser, eXSLProcessor, or eXPATH.
classification Either eMessage, eWarning, or eError.
locator The current Locator instance for the stylesheet. Maybe be a null pointer.
sourceNode The current source node, if any.
msg The error message.

Implements ProblemListenerBase.

virtual void XSLTProcessor::problem ( eSource  source,
eClassification  classification,
const XalanDOMString msg,
const XalanNode sourceNode 
) [pure virtual]

Function that is called when a problem event occurs.

This version assumes location information is already formatted into the message.

Parameters:
source either eXMLPARSER, eXSLPROCESSOR, or eXPATH
classification either eMESSAGE, eERROR or eWARNING
msg string message explaining the problem.

Implements ProblemListenerBase.

virtual void XSLTProcessor::process ( const XSLTInputSource inputSource,
XSLTResultTarget outputTarget,
StylesheetExecutionContext executionContext 
) [pure virtual]

Transform the source tree to the output in the given result tree target.

This function does not create a stylesheet tree, it assumes the provided StylesheetExecutionContext has the stylesheet tree to use. This is set by calling StylesheetExecutionContext::setStylesheetRoot().

Parameters:
inputSource input source
outputTarget output source tree
executionContext current execution context
Exceptions:
XSLProcessorException 
virtual void XSLTProcessor::process ( const XSLTInputSource inputSource,
const XSLTInputSource stylesheetSource,
XSLTResultTarget outputTarget,
StylesheetConstructionContext constructionContext,
StylesheetExecutionContext executionContext 
) [pure virtual]

Transform the source tree to the output in the given result tree target.

The processor will process the input source, the stylesheet source, and transform to the output target.

Parameters:
inputSource input source
stylesheetSource stylesheet source
outputTarget output source tree
constructionContext context for construction of objects
executionContext current execution context
Exceptions:
XSLProcessorException 
virtual StylesheetRoot* XSLTProcessor::processStylesheet ( const XSLTInputSource stylesheetSource,
StylesheetConstructionContext constructionContext 
) [pure virtual]

Given a stylesheet input source, compile the stylesheet into an internal representation.

Parameters:
stylesheetSource input source for the stylesheet
constructionContext context for construction of objects
Returns:
pointer to the compiled stylesheet object
Exceptions:
XSLProcessorException 
virtual StylesheetRoot* XSLTProcessor::processStylesheet ( const XalanDOMString xsldocURLString,
StylesheetConstructionContext constructionContext 
) [pure virtual]

Given a URI to an XSL stylesheet, compile the stylesheet into an internal representation.

Parameters:
xmldocURLString URI to the input XML document
constructionContext context for construction of objects
Returns:
pointer to compiled stylesheet object
Exceptions:
XSLProcessorException 
virtual void XSLTProcessor::removeTraceListener ( TraceListener tl  )  [pure virtual]

Remove a trace listener.

Parameters:
tl Trace listener to be removed.
virtual void XSLTProcessor::reset (  )  [pure virtual]

Reset the state.

This needs to be called after a process() call is invoked, if the processor is to be used again.

virtual void XSLTProcessor::resolveTopLevelParams ( StylesheetExecutionContext executionContext  )  [pure virtual]

Resolve the params that were pushed by the caller.

virtual void XSLTProcessor::setDiagnosticsOutput ( PrintWriter pw  )  [pure virtual]

If this is set, diagnostics will be written to the m_diagnosticsPrintWriter stream.

If the value is null, then diagnostics will be turned off.

Parameters:
pw pointer to print writer
virtual void XSLTProcessor::setExecutionContext ( StylesheetExecutionContext theExecutionContext  )  [pure virtual]

Set the execution context.

Must be set if after calling setStylesheetRoot.

Parameters:
theExecutionContext pointer to new execution context.
virtual void XSLTProcessor::setFormatterListener ( FormatterListener flistener  )  [pure virtual]

Set the current formatter listener.

Parameters:
flistener pointer to new formatter listener
virtual void XSLTProcessor::setQuietConflictWarnings ( bool  b  )  [pure virtual]

If the quietConflictWarnings property is set to true, warnings about pattern conflicts won't be printed to the diagnostics stream.

True by default.

Parameters:
b true if conflict warnings should be suppressed.
virtual void XSLTProcessor::setStylesheetParam ( const XalanDOMString key,
const XalanDOMString expression 
) [pure virtual]

Set a top-level parameter, which the stylesheet can access with a top-level xsl:param.

Top-level params are "sticky," and must be removed with a call to clearStylesheetParams().

Parameters:
key name of the param
expression expression that will be evaluated
virtual void XSLTProcessor::setStylesheetParam ( const XalanDOMString key,
XObjectPtr  value 
) [pure virtual]

Set a top-level parameter, which the stylesheet can access with a top-level xsl:param.

Top-level params are "sticky," and must be removed with a call to clearStylesheetParams().

Parameters:
key name of the parameter
value XObject value for parameter
virtual void XSLTProcessor::setStylesheetRoot ( const StylesheetRoot theStylesheet  )  [pure virtual]

Set the root stylesheet.

Parameters:
theStylesheet pointer to new root stylesheet
virtual void XSLTProcessor::traceSelect ( StylesheetExecutionContext executionContext,
const ElemTemplateElement theStylesheetElement,
const NodeRefListBase nl,
const XPath xpath 
) const [pure virtual]

Compose a diagnostic trace of the current selection.

Parameters:
executionContext The current execution context
theStylesheetElement The executing stylesheet element
nl The list of selected nodes
xpath A pointer to the XPath which generated the list of nodes, if any.

The documentation for this class was generated from the following file:

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo