Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
XSLTProcessorEnvSupportDefault Class Reference

#include <XSLTProcessorEnvSupportDefault.hpp>

Inherits XSLTProcessorEnvSupport.

Public Member Functions

 XSLTProcessorEnvSupportDefault (MemoryManager &theManager, XSLTProcessor *theProcessor=0)
 
virtual ~XSLTProcessorEnvSupportDefault ()
 
void setProcessor (XSLTProcessor *theProcessor)
 Reset the XLST processor instance. More...
 
virtual void installExternalFunctionLocal (const XalanDOMString &theNamespace, const XalanDOMString &functionName, const Function &function)
 Install an external function in the local space. More...
 
virtual void uninstallExternalFunctionLocal (const XalanDOMString &theNamespace, const XalanDOMString &functionName)
 Uninstall an external function from the local space. More...
 
virtual void problem (eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)
 Function that is called when a problem event occurs. More...
 
virtual void problem (eSource source, eClassification classification, const XalanDOMString &msg, const XalanNode *sourceNode)
 Function that is called when a problem event occurs. More...
 
virtual XalanDocumentparseXML (MemoryManager &theManager, const XalanDOMString &urlString, const XalanDOMString &base, ErrorHandler *theErrorHandler=0)
 Provides support for XML parsing service. More...
 
virtual XalanDocumentgetSourceDocument (const XalanDOMString &theURI) const
 Get the source document for the given URI. More...
 
virtual void setSourceDocument (const XalanDOMString &theURI, XalanDocument *theDocument)
 Associate a document with a given URI. More...
 
virtual const XalanDOMStringfindURIFromDoc (const XalanDocument *owner) const
 Given a DOM Document, tell what URI was used to parse it. More...
 
virtual bool elementAvailable (const XalanDOMString &theNamespace, const XalanDOMString &elementName) const
 Determine if an external element is available. More...
 
virtual bool functionAvailable (const XalanDOMString &theNamespace, const XalanDOMString &functionName) const
 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
 Handle an extension function. More...
 
virtual void reset ()
 Reset the instance. More...
 
 XSLTProcessorEnvSupportDefault (const XSLTProcessorEnvSupportDefault &)
 
XSLTProcessorEnvSupportDefaultoperator= (const XSLTProcessorEnvSupportDefault &)
 
bool operator== (const XSLTProcessorEnvSupportDefault &) const
 
- Public Member Functions inherited from XSLTProcessorEnvSupport
 XSLTProcessorEnvSupport ()
 
virtual ~XSLTProcessorEnvSupport ()
 
- Public Member Functions inherited from XPathEnvSupport
 XPathEnvSupport ()
 
virtual ~XPathEnvSupport ()
 
- Public Member Functions inherited from ProblemListenerBase
 ProblemListenerBase ()
 
virtual ~ProblemListenerBase ()
 

Static Public Member Functions

static void installExternalFunctionGlobal (const XalanDOMString &theNamespace, const XalanDOMString &functionName, const Function &function)
 Install an external function in the global space. More...
 
static void uninstallExternalFunctionGlobal (const XalanDOMString &theNamespace, const XalanDOMString &functionName)
 Uninstall an external function from the global space. More...
 
- Static Public Member Functions inherited from ProblemListenerBase
static void defaultFormat (PrintWriter &pw, eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)
 Function to format a problem call to a PrintWriter instance. More...
 
static void defaultFormat (PrintWriter &pw, eSource source, eClassification classification, const XalanDOMString &msg, const XalanNode *sourceNode)
 Function to format a problem call to a PrintWriter instance. More...
 

Public Attributes

XPathEnvSupportDefault m_defaultSupport
 
XSLTProcessorm_processor
 

Additional Inherited Members

- Public Types inherited from XPathEnvSupport
typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator LocatorType
 
typedef Function::XObjectArgVectorType XObjectArgVectorType
 
- Public Types inherited from ProblemListenerBase
enum  eSource {
  eXMLPARSER = 0, eXMLParser = 0, eXSLPROCESSOR = 1, eXSLTProcessor = 1,
  eXPATH = 2, eXPath = 2, eSourceCount
}
 
enum  eClassification {
  eMESSAGE = 0, eMessage = 0, eWARNING = 1, eWarning = 1,
  eERROR = 2, eError = 2, eClassificationCount
}
 
typedef eSource eProblemSource
 
- Static Protected Attributes inherited from ProblemListenerBase
static const XalanMessages::Codes s_messageCodes [eSourceCount][eClassificationCount]
 

Detailed Description

Definition at line 45 of file XSLTProcessorEnvSupportDefault.hpp.

Constructor & Destructor Documentation

◆ XSLTProcessorEnvSupportDefault() [1/2]

XSLTProcessorEnvSupportDefault::XSLTProcessorEnvSupportDefault ( MemoryManager &  theManager,
XSLTProcessor theProcessor = 0 
)

◆ ~XSLTProcessorEnvSupportDefault()

virtual XSLTProcessorEnvSupportDefault::~XSLTProcessorEnvSupportDefault ( )
virtual

◆ XSLTProcessorEnvSupportDefault() [2/2]

XSLTProcessorEnvSupportDefault::XSLTProcessorEnvSupportDefault ( const XSLTProcessorEnvSupportDefault )

Member Function Documentation

◆ elementAvailable()

virtual bool XSLTProcessorEnvSupportDefault::elementAvailable ( const XalanDOMString theNamespace,
const XalanDOMString elementName 
) const
virtual

Determine if an external element is available.

Parameters
theNamespacenamespace for the element
elementNamename of extension element
Returns
whether the element is available or not

Implements XSLTProcessorEnvSupport.

◆ extFunction()

virtual XObjectPtr XSLTProcessorEnvSupportDefault::extFunction ( XPathExecutionContext executionContext,
const XalanDOMString theNamespace,
const XalanDOMString functionName,
XalanNode context,
const XObjectArgVectorType argVec,
const Locator *  locator 
) const
virtual

Handle an extension function.

Parameters
executionContextcurrent execution context
theNamespacenamespace of function
functionNameextension function name
argVecvector of arguments to function
locatorA Locator instance for error reporting.
Returns
pointer to XObject result

Implements XSLTProcessorEnvSupport.

◆ findURIFromDoc()

virtual const XalanDOMString& XSLTProcessorEnvSupportDefault::findURIFromDoc ( const XalanDocument owner) const
virtual

Given a DOM Document, tell what URI was used to parse it.

Needed for relative resolution.

Parameters
ownersource document
Returns
document URI

Implements XSLTProcessorEnvSupport.

◆ functionAvailable()

virtual bool XSLTProcessorEnvSupportDefault::functionAvailable ( const XalanDOMString theNamespace,
const XalanDOMString functionName 
) const
virtual

Determine if a function is available.

For standard function availability, theNamespace should be an empty string.

Parameters
theNamespacenamespace for the function
functionNamename of the function
Returns
whether the function is available or not

Implements XSLTProcessorEnvSupport.

◆ getSourceDocument()

virtual XalanDocument* XSLTProcessorEnvSupportDefault::getSourceDocument ( const XalanDOMString theURI) const
virtual

Get the source document for the given URI.

Parameters
theURIdocument URI
Returns
source document

Implements XSLTProcessorEnvSupport.

◆ installExternalFunctionGlobal()

static void XSLTProcessorEnvSupportDefault::installExternalFunctionGlobal ( const XalanDOMString theNamespace,
const XalanDOMString functionName,
const Function function 
)
static

Install an external function in the global space.

Parameters
theNamespaceThe namespace for the functionl
functionNameThe name of the function.
functionThe function to install.

◆ installExternalFunctionLocal()

virtual void XSLTProcessorEnvSupportDefault::installExternalFunctionLocal ( const XalanDOMString theNamespace,
const XalanDOMString functionName,
const Function function 
)
virtual

Install an external function in the local space.

Parameters
theNamespaceThe namespace for the functionl
functionNameThe name of the function.
functionThe function to install.

◆ operator=()

XSLTProcessorEnvSupportDefault& XSLTProcessorEnvSupportDefault::operator= ( const XSLTProcessorEnvSupportDefault )

◆ operator==()

bool XSLTProcessorEnvSupportDefault::operator== ( const XSLTProcessorEnvSupportDefault ) const

◆ parseXML()

virtual XalanDocument* XSLTProcessorEnvSupportDefault::parseXML ( MemoryManager &  theManager,
const XalanDOMString urlString,
const XalanDOMString base,
ErrorHandler *  theErrorHandler = 0 
)
virtual

Provides support for XML parsing service.

Parameters
theManagerThe MemoryManager instance to use.
urlStringlocation of the XML
basebase location for URI
theErrorHandlerAn optional ErrorHandler instance for error reporting.
Returns
parsed document

Implements XSLTProcessorEnvSupport.

◆ problem() [1/2]

virtual void XSLTProcessorEnvSupportDefault::problem ( eSource  source,
eClassification  classification,
const XalanDOMString msg,
const Locator *  locator,
const XalanNode sourceNode 
)
virtual

Function that is called when a problem event occurs.

Parameters
sourceEither eXMLParser, eXSLProcessor, or eXPATH.
classificationEither eMessage, eWarning, or eError.
locatorThe current Locator instance for the stylesheet. Maybe be a null pointer.
sourceNodeThe current source node, if any.
msgThe error message.

Implements XSLTProcessorEnvSupport.

◆ problem() [2/2]

virtual void XSLTProcessorEnvSupportDefault::problem ( eSource  source,
eClassification  classification,
const XalanDOMString msg,
const XalanNode sourceNode 
)
virtual

Function that is called when a problem event occurs.

This version assumes location information is already formatted into the message.

Parameters
sourceeither eXMLPARSER, eXSLPROCESSOR, or eXPATH
classificationeither eMESSAGE, eERROR or eWARNING
msgstring message explaining the problem.

Implements XSLTProcessorEnvSupport.

◆ reset()

virtual void XSLTProcessorEnvSupportDefault::reset ( )
virtual

Reset the instance.

Implements XSLTProcessorEnvSupport.

◆ setProcessor()

void XSLTProcessorEnvSupportDefault::setProcessor ( XSLTProcessor theProcessor)
inline

Reset the XLST processor instance.

Parameters
theProcessorpointer to new processor instance

Definition at line 62 of file XSLTProcessorEnvSupportDefault.hpp.

◆ setSourceDocument()

virtual void XSLTProcessorEnvSupportDefault::setSourceDocument ( const XalanDOMString theURI,
XalanDocument theDocument 
)
virtual

Associate a document with a given URI.

Parameters
theURIdocument URI
theDocumentsource document

Implements XSLTProcessorEnvSupport.

◆ uninstallExternalFunctionGlobal()

static void XSLTProcessorEnvSupportDefault::uninstallExternalFunctionGlobal ( const XalanDOMString theNamespace,
const XalanDOMString functionName 
)
static

Uninstall an external function from the global space.

Parameters
theNamespaceThe namespace for the functionl
functionNameThe name of the function.

◆ uninstallExternalFunctionLocal()

virtual void XSLTProcessorEnvSupportDefault::uninstallExternalFunctionLocal ( const XalanDOMString theNamespace,
const XalanDOMString functionName 
)
virtual

Uninstall an external function from the local space.

Parameters
theNamespaceThe namespace for the functionl
functionNameThe name of the function.

Member Data Documentation

◆ m_defaultSupport

XPathEnvSupportDefault XSLTProcessorEnvSupportDefault::m_defaultSupport

Definition at line 189 of file XSLTProcessorEnvSupportDefault.hpp.

◆ m_processor

XSLTProcessor* XSLTProcessorEnvSupportDefault::m_processor

Definition at line 191 of file XSLTProcessorEnvSupportDefault.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