Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

XPathEnvSupport Class Reference

#include <XPathEnvSupport.hpp>

Inheritance diagram for XPathEnvSupport

Inheritance graph

[legend]
Collaboration diagram for XPathEnvSupport:

Collaboration graph

[legend]
List of all members.

Public Types

Public Methods


Member Typedef Documentation

typedef Function::XObjectArgVectorType XPathEnvSupport::XObjectArgVectorType
 


Member Enumeration Documentation

enum XPathEnvSupport::eClassification
 

Enumeration values:
eMessage  
eWarning  
eError  

enum XPathEnvSupport::eSource
 

Enumeration values:
eXMLParser  
eXSLTProcessor  
eXPATHParser  
eXPATHProcessor  
eDataSource  


Constructor & Destructor Documentation

XPathEnvSupport::XPathEnvSupport ( )
 

virtual XPathEnvSupport::~XPathEnvSupport ( ) [virtual]
 


Member Function Documentation

void XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

bool XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

XObjectPtr XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

XalanDOMString XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

bool XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

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

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

Returns:
DOM document

Reimplemented in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

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

Get the source document for the given URI.

Parameters:
theURI   document URI
Returns:
source document

Reimplemented in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

XLocator * XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

XalanDocument * XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

bool XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

bool XPathEnvSupport::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
styleNode   style tree node where the problem occurred (may be null)
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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

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

Reset the instance.

Reimplemented from Resettable.

Reimplemented in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

void XPathEnvSupport::setSourceDocument ( const XalanDOMString & theURI,
XalanDocument * theDocument ) [pure virtual]
 

Associate a document with a given URI.

Parameters:
theURI   document URI
theDocument   source document

Reimplemented in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.

bool XPathEnvSupport::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 in XPathEnvSupportDefault, XSLTProcessorEnvSupport, and XSLTProcessorEnvSupportDefault.


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++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.