Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

ExtensionFunctionHandler Class Reference

Class handling an extension namespace for XPath. More...

#include <ExtensionFunctionHandler.hpp>

Inherited by ExtensionNSHandler.

Collaboration diagram for ExtensionFunctionHandler:
Collaboration graph
[legend]

List of all members.

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes


Detailed Description

Class handling an extension namespace for XPath.

Provides functions to test a function's existence and call a function

Definition at line 58 of file ExtensionFunctionHandler.hpp.


Member Typedef Documentation

Vector of pointers to function arguments.

Definition at line 140 of file ExtensionFunctionHandler.hpp.

Definition at line 142 of file ExtensionFunctionHandler.hpp.


Constructor & Destructor Documentation

ExtensionFunctionHandler::ExtensionFunctionHandler ( const XalanDOMString namespaceUri,
MemoryManager &  theManager 
)

Construct a new extension namespace handler for a given extension NS.

This doesn't do anything - just hang on to the namespace URI.

Parameters:
namespaceUri the extension namespace URI that I'm implementing
ExtensionFunctionHandler::ExtensionFunctionHandler ( MemoryManager &  theManager,
const XalanDOMString namespaceUri,
const XalanDOMString funcNames,
const XalanDOMString lang,
const XalanDOMString srcURL,
const XalanDOMString scriptSrc 
)

Construct a new extension namespace handler given all the information needed.

Parameters:
namespaceUri the extension namespace URI that I'm implementing
funcNames string containing list of functions of extension NS
lang language of code implementing the extension
srcURL value of src attribute (if any) - treated as a URL or a classname depending on the value of lang. If srcURL is not null, then scriptSrc is ignored.
scriptSrc the actual script code (if any)
virtual ExtensionFunctionHandler::~ExtensionFunctionHandler (  )  [virtual]

Member Function Documentation

virtual XObjectPtr ExtensionFunctionHandler::callFunction ( const XalanDOMString funcName,
const ArgVectorType args 
) [virtual]

Process a call to a function.

Parameters:
funcName Function name.
args The arguments of the function call.
Returns:
the return value of the function evaluation.
Exceptions:
XSLProcessorException thrown if something goes wrong while running the extension handler.
MalformedURLException if loading trouble
FileNotFoundException if loading trouble
IOException if loading trouble
SAXException if parsing trouble
MemoryManager& ExtensionFunctionHandler::getMemoryManager (  )  [inline]

Definition at line 97 of file ExtensionFunctionHandler.hpp.

virtual bool ExtensionFunctionHandler::isFunctionAvailable ( const XalanDOMString function  )  const [virtual]

Tests whether a certain function name is known within this namespace.

Parameters:
function name of the function being tested
Returns:
true if its known, false if not.
virtual void ExtensionFunctionHandler::setFunctions ( const XalanDOMString funcNames  )  [virtual]

Set function local parts of extension NS.

Parameters:
functions whitespace separated list of function names defined by this extension namespace.

Reimplemented in ExtensionNSHandler.

virtual void ExtensionFunctionHandler::setScript ( const XalanDOMString lang,
const XalanDOMString srcURL,
const XalanDOMString scriptSrc 
) [virtual]

Set the script data for this extension NS.

If srcURL is !null then the script body is read from that URL. If not the scriptSrc is used as the src. This method does not actually execute anything - that's done when the component is first hit by the user by an element or a function call.

Parameters:
lang language of the script.
srcURL value of src attribute (if any) - treated as a URL or a classname depending on the value of lang. If srcURL is not null, then scriptSrc is ignored.
scriptSrc the actual script code (if any)

Reimplemented in ExtensionNSHandler.

virtual void ExtensionFunctionHandler::startupComponent (  )  [protected, virtual]

Start the component up by executing any script that needs to run at startup time.

This needs to happen before any functions can be called on the component.

Exceptions:
XPathProcessorException if something bad happens.

Reimplemented in ExtensionNSHandler.


Member Data Documentation

Definition at line 178 of file ExtensionFunctionHandler.hpp.

Definition at line 174 of file ExtensionFunctionHandler.hpp.

Definition at line 172 of file ExtensionFunctionHandler.hpp.

Definition at line 167 of file ExtensionFunctionHandler.hpp.

Definition at line 168 of file ExtensionFunctionHandler.hpp.

Definition at line 169 of file ExtensionFunctionHandler.hpp.

Definition at line 170 of file ExtensionFunctionHandler.hpp.

const XalanDOMChar ExtensionFunctionHandler::s_tokenDelimiterCharacters[] [static, protected]

Definition at line 192 of file ExtensionFunctionHandler.hpp.


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