Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Types | Public Member Functions | List of all members
XPathEnvSupport Class Referenceabstract
Inheritance diagram for XPathEnvSupport:
XPathEnvSupportDefault XSLTProcessorEnvSupport XSLTProcessorEnvSupportDefault

Public Types

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

 XPathEnvSupport ()
 
virtual ~XPathEnvSupport ()
 
virtual XalanDocumentparseXML (MemoryManagerType &theManager, const XalanDOMString &urlString, const XalanDOMString &base)=0
 Provides support for XML parsing service. More...
 
virtual XalanDocumentgetSourceDocument (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 const XalanDOMStringfindURIFromDoc (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. More...
 

Member Typedef Documentation

typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator XPathEnvSupport::LocatorType

Member Enumeration Documentation

Enumerator
eMessage 
eWarning 
eError 
Enumerator
eXMLParser 
eXSLTProcessor 
eXPATHParser 
eXPATHProcessor 
eDataSource 

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
theNamespacenamespace for the element
elementNamename of extension element
Returns
whether the element is available or not

Implemented in XPathEnvSupportDefault, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupport.

virtual XObjectPtr XPathEnvSupport::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
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

Implemented in XPathEnvSupportDefault, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupport.

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
ownersource document
Returns
document URI

Implemented in XPathEnvSupportDefault, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupport.

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
theNamespacenamespace for the function
functionNamename of the function
Returns
whether the function is available or not

Implemented in XPathEnvSupportDefault, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupport.

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

Get the source document for the given URI.

Parameters
theURIdocument URI
Returns
source document

Implemented in XPathEnvSupportDefault, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupport.

virtual XalanDocument* XPathEnvSupport::parseXML ( MemoryManagerType theManager,
const XalanDOMString urlString,
const XalanDOMString base 
)
pure virtual

Provides support for XML parsing service.

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

Implemented in XPathEnvSupportDefault, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupport.

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

Implemented in XPathEnvSupportDefault, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupport.

virtual void XPathEnvSupport::reset ( )
pure virtual
virtual void XPathEnvSupport::setSourceDocument ( const XalanDOMString theURI,
XalanDocument theDocument 
)
pure virtual

Associate a document with a given URI.

Parameters
theURIdocument URI
theDocumentsource document

Implemented in XPathEnvSupportDefault, XSLTProcessorEnvSupportDefault, and XSLTProcessorEnvSupport.


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