Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

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

XPathEnvSupport Class Reference

#include <XPathEnvSupport.hpp>

Inheritance diagram for XPathEnvSupport:

Collaboration diagram for XPathEnvSupport:

List of all members.

Public Types

typedef Function::XObjectArgVectorType XObjectArgVectorType
enum eSource {
  eXMLParser = 1,
  eXSLTProcessor = 2,
  eXPATHParser = 3,
  eXPATHProcessor = 4,
  eDataSource = 5
}
enum eClassification {
  eMessage = 0,
  eWarning = 1,
  eError = 2
}

Public Methods

XPathEnvSupport ()
virtual ~XPathEnvSupport ()
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 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 XObjectPtr extFunction ( XPathExecutionContext& executionContext, const XalanDOMString& theNamespace, const XalanDOMString& functionName, XalanNode* context, const XObjectArgVectorType& argVec, const Locator* locator) const = 0
Handle an extension function. More...
virtual bool problem ( eSource where, eClassification classification, const XalanNode* styleNode, const XalanNode* sourceNode, const XalanDOMString& msg, const XalanDOMChar* uri, 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, const XalanDOMChar* uri, 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

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

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 Locator * locator) 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
locator	A Locator instance for error reporting.

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::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.

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,

const XalanDOMChar * uri,

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 0)
msg	string message explaining the problem.
uri	the URI of the stylesheet, if available. May be 0;
lineNo	line number where the problem occurred, if it is known, else -1
charOffset	character offset where the problem, occurred if it is known, else -1

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, XPathEnvSupportDefault, XSLTProcessorEnvSupport, XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupportDefault.

bool XPathEnvSupport::problem ( eSource where,

eClassification classification,

const XalanNode * styleNode,

const XalanNode * sourceNode,

const XalanDOMString & msg,

const XalanDOMChar * uri,

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 0)
sourceNode	source tree node where the problem occurred (may be 0)
msg	string message explaining the problem.
uri	the URI of the stylesheet, if available. May be 0;
lineNo	line number where the problem occurred, if it is known, else -1
charOffset	character offset where the problem, occurred if it is known, else -1

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, XPathEnvSupportDefault, XSLTProcessorEnvSupport, XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, 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.

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

XPathEnvSupport.hpp

Interpreting class diagrams

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