## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.6

Main Page 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 bool problem ( eSource where, eClassification classification, const XalanNode* sourceNode, const ElemTemplateElement* styleNode, const XalanDOMString& msg, const XalanDOMChar* uri, int lineNo, int charOffset) const = 0
    Function that is called when a problem event occurs. More...
- 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 LocatorType* locator) const = 0
    Handle an extension function. 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.

## Constructor & Destructor Documentation

XSLTProcessorEnvSupport::XSLTProcessorEnvSupport ( | )

virtual XSLTProcessorEnvSupport::~XSLTProcessorEnvSupport ( | )`[virtual]`

## Member Function Documentation

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 XObjectPtr XSLTProcessorEnvSupport::extFunction ( | XPathExecutionContext & executionContext,
| const XalanDOMString & theNamespace,
| const XalanDOMString & functionName,
| XalanNode * context,
| const XObjectArgVectorType & argVec,
| const LocatorType * 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 LocatorType instance for error reporting.

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::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 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,
| 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.
  charOffset | character offset where the problem.

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.

bool XSLTProcessorEnvSupport::problem ( | eSource where,
| eClassification classification,
| const XalanNode * sourceNode,
| const ElemTemplateElement * styleNode,
| 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)
  styleNode | stylesheet 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.
  charOffset | character offset where the problem.

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

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.

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.

Xalan-C++ XSLT Processor Version 1.6 Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.