Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

XSLTProcessorEnvSupport Class Reference

#include <XSLTProcessorEnvSupport.hpp>

Inheritance diagram for XSLTProcessorEnvSupport:

Collaboration diagram for XSLTProcessorEnvSupport:

List of all members.

Public Methods

XSLTProcessorEnvSupport ()
virtual ~XSLTProcessorEnvSupport ()
virtual XalanDocument* parseXML ( const XalanDOMString& urlString, const XalanDOMString& base) = 0
Provides support for XML parsing service. More...
virtual XalanDocument* getSourceDocument (const XalanDOMString& theURI) const = 0
Get the source document for the given URI. More...
virtual void setSourceDocument ( const XalanDOMString& theURI, XalanDocument* theDocument) = 0
Associate a document with a given URI. More...
virtual XalanDOMString findURIFromDoc (const XalanDocument* owner) const = 0
Given a DOM Document, tell what URI was used to parse it. More...
virtual XalanDocument* getDOMFactory () const = 0
Get a DOM document, primarily for creating result tree fragments. More...
virtual bool elementAvailable ( const XalanDOMString& theNamespace, const XalanDOMString& elementName) const = 0
Determine if an external element is available. More...
virtual bool functionAvailable ( const XalanDOMString& theNamespace, const XalanDOMString& functionName) const = 0
Determine if a function is available. More...
virtual XObject* extFunction ( XPathExecutionContext& executionContext, const XalanDOMString& theNamespace, const XalanDOMString& functionName, XalanNode* context, const XObjectArgVectorType& argVec) const = 0
Handle an extension function. More...
virtual XLocator* getXLocatorFromNode (const XalanNode* node) const = 0
Get an XLocator provider keyed by node. More...
virtual void associateXLocatorToNode ( const XalanNode* node, XLocator* xlocator) = 0
Associate an XLocator provider to a node. More...
virtual bool shouldStripSourceNode ( XPathExecutionContext& executionContext, const XalanNode& node) const = 0
Tells, through the combination of the default-space attribute on xsl:stylesheet, xsl:strip-space, xsl:preserve-space, and the xml:space attribute, whether or not extra whitespace should be stripped from the node. More...
virtual bool problem ( eSource where, eClassification classification, const XalanNode* styleNode, const XalanNode* sourceNode, const XalanDOMString& msg, int lineNo, int charOffset) const = 0
Function that is called when a problem event occurs. More...
virtual bool problem ( eSource where, eClassification classification, const PrefixResolver* resolver, const XalanNode* sourceNode, const XalanDOMString& msg, int lineNo, int charOffset) const = 0
Function that is called when a problem event occurs. More...
virtual void reset () = 0
Reset the instance.

Detailed Description

Constructor & Destructor Documentation

XSLTProcessorEnvSupport::XSLTProcessorEnvSupport ()

virtual XSLTProcessorEnvSupport::~XSLTProcessorEnvSupport () [virtual]

Member Function Documentation

virtual void XSLTProcessorEnvSupport::associateXLocatorToNode ( const XalanNode * node,

XLocator * xlocator) [pure virtual]

Associate an XLocator provider to a node.

This makes the association based on the root of the tree that is the node's parent.

Parameters:

node	node for association
xlocator	locator to associate with node

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual bool XSLTProcessorEnvSupport::elementAvailable ( const XalanDOMString & theNamespace,

const XalanDOMString & elementName) const [pure virtual]

Determine if an external element is available.

Parameters:

theNamespace	namespace for the element
elementName	name of extension element

Returns:: whether the element is available or not

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual XObject* XSLTProcessorEnvSupport::extFunction ( XPathExecutionContext & executionContext,

const XalanDOMString & theNamespace,

const XalanDOMString & functionName,

XalanNode * context,

const XObjectArgVectorType & argVec) const [pure virtual]

Handle an extension function.

Parameters:

executionContext	current execution context
theNamespace	namespace of function
functionName	extension function name
argVec	vector of arguments to function

Returns:: pointer to XObject result

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual XalanDOMString XSLTProcessorEnvSupport::findURIFromDoc ( const XalanDocument * owner) const [pure virtual]

Given a DOM Document, tell what URI was used to parse it.

Needed for relative resolution.

Parameters:

owner

source document

Returns:: document URI

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual bool XSLTProcessorEnvSupport::functionAvailable ( const XalanDOMString & theNamespace,

const XalanDOMString & functionName) const [pure virtual]

Determine if a function is available.

For standard function availability, theNamespace should be an empty string.

Parameters:

theNamespace	namespace for the function
functionName	name of the function

Returns:: whether the function is available or not

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual XalanDocument* XSLTProcessorEnvSupport::getDOMFactory () const [pure virtual]

Get a DOM document, primarily for creating result tree fragments.

Returns:: DOM document

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual XalanDocument* XSLTProcessorEnvSupport::getSourceDocument ( const XalanDOMString & theURI) const [pure virtual]

Get the source document for the given URI.

Parameters:

theURI

document URI

Returns:: source document

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual XLocator* XSLTProcessorEnvSupport::getXLocatorFromNode ( const XalanNode * node) const [pure virtual]

Get an XLocator provider keyed by node.

This gets the association based on the root of the tree that is the node's parent.

Parameters:

node

node for locator

Returns:: pointer to locator

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual XalanDocument* XSLTProcessorEnvSupport::parseXML ( const XalanDOMString & urlString,

const XalanDOMString & base) [pure virtual]

Provides support for XML parsing service.

Parameters:

urlString	location of the XML
base	base location for URI

Returns:: parsed document

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual bool XSLTProcessorEnvSupport::problem ( eSource where,

eClassification classification,

const PrefixResolver * resolver,

const XalanNode * sourceNode,

const XalanDOMString & msg,

int lineNo,

int charOffset) const [pure virtual]

Function that is called when a problem event occurs.

Parameters:

where	either eXMLParser, eXSLTProcessor, eXPATHParser, eXPATHProcessor, or eDataSource.
classification	either eWarning, or eError
resolver	resolver for namespace resolution
sourceNode	source tree node where the problem occurred (may be null)
msg	string message explaining the problem.
lineNo	line number where the problem occurred, if it is known, else zero
charOffset	character offset where the problem, occurred if it is known, else zero

Returns:: true if the return is an ERROR, in which case exception will be thrown. Otherwise the processor will continue to process.

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual bool XSLTProcessorEnvSupport::problem ( eSource where,

eClassification classification,

const XalanNode * styleNode,

const XalanNode * sourceNode,

const XalanDOMString & msg,

int lineNo,

int charOffset) const [pure virtual]

Function that is called when a problem event occurs.

Parameters:

where	either eXMLParser, eXSLTProcessor, eXPATHParser, eXPATHProcessor, or eDataSource.
classification	either eWarning, or eError
resolver	resolver for namespace resolution
sourceNode	source tree node where the problem occurred (may be null)
msg	string message explaining the problem.
lineNo	line number where the problem occurred, if it is known, else zero
charOffset	character offset where the problem, occurred if it is known, else zero

Returns:: true if the return is an ERROR, in which case exception will be thrown. Otherwise the processor will continue to process.

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual void XSLTProcessorEnvSupport::reset () [pure virtual]

Reset the instance.

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual void XSLTProcessorEnvSupport::setSourceDocument ( const XalanDOMString & theURI,

XalanDocument * theDocument) [pure virtual]

Associate a document with a given URI.

Parameters:

theURI	document URI
theDocument	source document

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

virtual bool XSLTProcessorEnvSupport::shouldStripSourceNode ( XPathExecutionContext & executionContext,

const XalanNode & node) const [pure virtual]

Tells, through the combination of the default-space attribute on xsl:stylesheet, xsl:strip-space, xsl:preserve-space, and the xml:space attribute, whether or not extra whitespace should be stripped from the node.

Literal elements from template elements should not be tested with this function.

Parameters:

executionContext	current execution context
node	text node from the source tree

Returns:: true if the text node should be stripped of extra whitespace

Reimplemented from XPathEnvSupport.

Reimplemented in XSLTProcessorEnvSupportDefault.

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

XSLTProcessorEnvSupport.hpp

Interpreting class diagrams

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