#include <XPathEnvSupport.hpp>

Inherits ProblemListenerBase.

Inherited by XPathEnvSupportDefault, and XSLTProcessorEnvSupport.

Collaboration diagram for XPathEnvSupport:

[legend]

List of all members.

Public Types

typedef
XERCES_CPP_NAMESPACE_QUALIFIER
Locator LocatorType
typedef
Function::XObjectArgVectorType XObjectArgVectorType

Public Member Functions

XPathEnvSupport ()
virtual ~XPathEnvSupport ()
virtual void problem (eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)=0
Function that is called when a problem event occurs.
virtual void problem (eSource source, eClassification classification, const XalanDOMString &msg, const XalanNode *sourceNode)=0
Function that is called when a problem event occurs.
virtual XalanDocument * parseXML (MemoryManager &theManager, const XalanDOMString &urlString, const XalanDOMString &base, ErrorHandler *theErrorHandler=0)=0
Provides support for XML parsing service.
virtual XalanDocument * getSourceDocument (const XalanDOMString &theURI) const =0
Get the source document for the given URI.
virtual void setSourceDocument (const XalanDOMString &theURI, XalanDocument *theDocument)=0
Associate a document with a given URI.
virtual const XalanDOMString & findURIFromDoc (const XalanDocument *owner) const =0
Given a DOM Document, tell what URI was used to parse it.
virtual bool elementAvailable (const XalanDOMString &theNamespace, const XalanDOMString &elementName) const =0
Determine if an external element is available.
virtual bool functionAvailable (const XalanDOMString &theNamespace, const XalanDOMString &functionName) const =0
Determine if a function is available.
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.
virtual void reset ()=0
Reset the instance.

Detailed Description

Definition at line 57 of file XPathEnvSupport.hpp.

Member Typedef Documentation

typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator XPathEnvSupport::LocatorType

Definition at line 61 of file XPathEnvSupport.hpp.

typedef Function::XObjectArgVectorType XPathEnvSupport::XObjectArgVectorType

Definition at line 63 of file XPathEnvSupport.hpp.

Constructor & Destructor Documentation

XPathEnvSupport::XPathEnvSupport ( )

virtual XPathEnvSupport::~XPathEnvSupport ( ) [virtual]

Member Function Documentation

virtual 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

Implemented in XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, and XPathEnvSupportDefault.

virtual 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

Implemented in XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, and XPathEnvSupportDefault.

virtual const 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

Implemented in XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, and XPathEnvSupportDefault.

virtual 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

Implemented in XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, and XPathEnvSupportDefault.

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

Get the source document for the given URI.

Parameters:

theURI

document URI

Returns:: source document

Implemented in XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, and XPathEnvSupportDefault.

virtual XalanDocument* XPathEnvSupport::parseXML	(	MemoryManager &	theManager,
		const XalanDOMString &	urlString,
		const XalanDOMString &	base,
		ErrorHandler *	theErrorHandler = `0`
	)			`[pure virtual]`

Provides support for XML parsing service.

Parameters:

	theManager	The MemoryManager instance to use.
	urlString	location of the XML
	base	base location for URI
	theErrorHandler	An optional ErrorHandler instance for error reporting.

Returns:: parsed document

Implemented in XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, and XPathEnvSupportDefault.

virtual void XPathEnvSupport::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.

Implemented in XSLTProcessorEnvSupport, XSLTProcessorEnvSupportDefault, and XPathEnvSupportDefault.

virtual void XPathEnvSupport::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.