Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
XPathEnvSupportDefault Class Reference

Dummy class in order to make the XPath object happy for diagnostic purposes. More...

Inheritance diagram for XPathEnvSupportDefault:
XPathEnvSupport

Classes

struct  NamespaceFunctionTableDeleteFunctor
 

Public Types

typedef XalanMap
< XalanDOMString,
XalanDocument * > 
SourceDocsTableType
 
typedef FunctionTableTypeDefinition FunctionTableType
 
typedef XalanMap
< XalanDOMString,
FunctionTableType
NamespaceFunctionTablesType
 
- Public Types inherited from XPathEnvSupport
enum  eSource {
  eXMLParser = 1, eXSLTProcessor = 2, eXPATHParser = 3, eXPATHProcessor = 4,
  eDataSource = 5
}
 
enum  eClassification { eMessage = 0, eWarning = 1, eError = 2 }
 
typedef
XERCES_CPP_NAMESPACE_QUALIFIER
Locator 
LocatorType
 
typedef
Function::XObjectArgVectorType 
XObjectArgVectorType
 

Public Member Functions

 XPathEnvSupportDefault (MemoryManagerType &theManager XALAN_DEFAULT_MEMMGR)
 
virtual ~XPathEnvSupportDefault ()
 
MemoryManagerTypegetMemoryManager ()
 
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 XalanDocumentparseXML (MemoryManagerType &theManager, const XalanDOMString &urlString, const XalanDOMString &base)
 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 LocatorType *locator) const
 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
 Function that is called when a problem event occurs. More...
 
virtual void reset ()
 Reset the instance. More...
 
- Public Member Functions inherited from XPathEnvSupport
 XPathEnvSupport ()
 
virtual ~XPathEnvSupport ()
 

Static Public Member Functions

static void initialize (MemoryManagerType &theManager)
 Perform initialization of statics – must be called before any processing occurs. More...
 
static void terminate ()
 Perform termination of statics. More...
 
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...
 

Protected Member Functions

const FunctionfindFunction (const XalanDOMString &theNamespace, const XalanDOMString &functionName) const
 Find an external function. More...
 

Detailed Description

Dummy class in order to make the XPath object happy for diagnostic purposes.

Author
David N. Bertoni

Member Typedef Documentation

Constructor & Destructor Documentation

XPathEnvSupportDefault::XPathEnvSupportDefault ( MemoryManagerType &theManager  XALAN_DEFAULT_MEMMGR)
virtual XPathEnvSupportDefault::~XPathEnvSupportDefault ( )
virtual

Member Function Documentation

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

virtual XObjectPtr XPathEnvSupportDefault::extFunction ( XPathExecutionContext executionContext,
const XalanDOMString theNamespace,
const XalanDOMString functionName,
XalanNode context,
const XObjectArgVectorType argVec,
const LocatorType locator 
) const
virtual

Handle an extension function.

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

Implements XPathEnvSupport.

const Function* XPathEnvSupportDefault::findFunction ( const XalanDOMString theNamespace,
const XalanDOMString functionName 
) const
protected

Find an external function.

Parameters
theNamespaceThe namespace for the function.
functionNameThe name of the function.
Returns
a pointer to the function if found, or 0 if not found.
virtual const XalanDOMString& XPathEnvSupportDefault::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 XPathEnvSupport.

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

MemoryManagerType& XPathEnvSupportDefault::getMemoryManager ( )
virtual XalanDocument* XPathEnvSupportDefault::getSourceDocument ( const XalanDOMString theURI) const
virtual

Get the source document for the given URI.

Parameters
theURIdocument URI
Returns
source document

Implements XPathEnvSupport.

static void XPathEnvSupportDefault::initialize ( MemoryManagerType theManager)
static

Perform initialization of statics – must be called before any processing occurs.

See class XPathInit.

static void XPathEnvSupportDefault::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.
virtual void XPathEnvSupportDefault::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.
virtual XalanDocument* XPathEnvSupportDefault::parseXML ( MemoryManagerType theManager,
const XalanDOMString urlString,
const XalanDOMString base 
)
virtual

Provides support for XML parsing service.

Parameters
urlStringlocation of the XML
basebase location for URI
Returns
parsed document

Implements XPathEnvSupport.

virtual bool XPathEnvSupportDefault::problem ( eSource  where,
eClassification  classification,
const PrefixResolver resolver,
const XalanNode sourceNode,
const XalanDOMString msg,
const XalanDOMChar *  uri,
int  lineNo,
int  charOffset 
) const
virtual

Function that is called when a problem event occurs.

Parameters
whereeither eXMLParser, eXSLTProcessor, eXPATHParser, eXPATHProcessor, or eDataSource.
classificationeither eWarning, or eError
resolverresolver for namespace resolution
sourceNodesource tree node where the problem occurred (may be 0)
msgstring message explaining the problem.
urithe URI of the stylesheet, if available. May be 0;
lineNoline number where the problem occurred.
charOffsetcharacter 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.

Implements XPathEnvSupport.

virtual void XPathEnvSupportDefault::reset ( )
virtual

Reset the instance.

Implements XPathEnvSupport.

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

Associate a document with a given URI.

Parameters
theURIdocument URI
theDocumentsource document

Implements XPathEnvSupport.

static void XPathEnvSupportDefault::terminate ( )
static

Perform termination of statics.

See class XPathInit.

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

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.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo