Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Classes | Public Types | Public Member Functions | Protected Attributes

XPathExecutionContext Class Reference

#include <XPathExecutionContext.hpp>

Inherits ExecutionContext.

Inherited by StylesheetExecutionContext, and XPathExecutionContextDefault.

Collaboration diagram for XPathExecutionContext:
Collaboration graph
[legend]

List of all members.

Classes

Public Types

Public Member Functions

Protected Attributes


Detailed Description

Definition at line 79 of file XPathExecutionContext.hpp.


Member Typedef Documentation

Definition at line 425 of file XPathExecutionContext.hpp.

Definition at line 502 of file XPathExecutionContext.hpp.

Definition at line 85 of file XPathExecutionContext.hpp.

Definition at line 83 of file XPathExecutionContext.hpp.


Constructor & Destructor Documentation

XPathExecutionContext::XPathExecutionContext ( MemoryManager &  theMemoryManager,
XObjectFactory theXObjectFactory = 0 
) [explicit]
virtual XPathExecutionContext::~XPathExecutionContext (  )  [virtual]

Member Function Documentation

virtual MutableNodeRefList* XPathExecutionContext::borrowMutableNodeRefList (  )  [pure virtual]

Borrow a cached MutableNodeRefList instance.

Returns:
A pointer to the instance.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual MutableNodeRefList* XPathExecutionContext::createMutableNodeRefList ( MemoryManager &  theManager  )  const [pure virtual]

Create a MutableNodeRefList with the appropriate context.

Returns:
pointer to node list created

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual bool XPathExecutionContext::elementAvailable ( const XalanQName theQName  )  const [pure virtual]

Determine if an external element is available.

Parameters:
theQName The QName of the element
Returns:
whether the given element is available or not

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual bool XPathExecutionContext::elementAvailable ( const XalanDOMString theName,
const Locator *  locator 
) const [pure virtual]

Determine if an external element is available by resolving a string to a QName.

Parameters:
theName The name of the element
locator A Locator instance for error reporting
Returns:
whether the given element is available or not

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual const XObjectPtr XPathExecutionContext::extFunction ( const XalanDOMString theNamespace,
const XalanDOMString functionName,
XalanNode context,
const XObjectArgVectorType argVec,
const Locator *  locator 
) [pure virtual]

Handle an extension function.

Parameters:
theNamespace namespace of function
functionName extension function name
context The context node
argVec vector of arguments to function
locator A Locator instance for error reporting
Returns:
pointer to XObject result

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual const XalanDOMString& XPathExecutionContext::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

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::formatNumber ( double  number,
const XalanDOMString pattern,
XalanDOMString theResult,
const XalanNode context = 0,
const Locator *  locator = 0 
) [pure virtual]

Formats a number according to the specified pattern.

Parameters:
number the number to be formatted
pattern the format pattern
theResult the formatted number
context the source node
locator the locator

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::formatNumber ( double  number,
const XalanDOMString pattern,
const XalanDOMString dfsName,
XalanDOMString theResult,
const XalanNode context = 0,
const Locator *  locator = 0 
) [pure virtual]

Formats a number according to the specified pattern.

Parameters:
number the number to be formatted
pattern the format pattern
dfsName the name of decimal format to use
theResult the formatted number
context the source node
locator the locator
Returns:
a pointer to the functor, 0 if none was found

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual bool XPathExecutionContext::functionAvailable ( const XalanQName theQName  )  const [pure virtual]

Determine if a function is available.

Parameters:
theQName The QName of the function
Returns:
whether the function is available or not

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual bool XPathExecutionContext::functionAvailable ( const XalanDOMString theName,
const Locator *  locator 
) const [pure virtual]

Determine if a function is available.

Parameters:
theName The name of the function
locator A Locator instance for error reporting
Returns:
whether the function is available or not

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual XalanDOMString& XPathExecutionContext::getCachedString (  )  [pure virtual]

Get a cached string for temporary use.

Returns:
A reference to the string

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual const NodeRefListBase& XPathExecutionContext::getContextNodeList (  )  const [pure virtual]

Get the node list for current context.

Returns:
node list

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual size_type XPathExecutionContext::getContextNodeListLength (  )  const [pure virtual]
virtual size_type XPathExecutionContext::getContextNodeListPosition ( const XalanNode contextNode  )  const [pure virtual]
virtual XalanNode* XPathExecutionContext::getCurrentNode (  )  const [pure virtual]

Retrieve the node currently being executed.

Returns:
current node

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual const XalanDOMString* XPathExecutionContext::getNamespaceForPrefix ( const XalanDOMString prefix  )  const [pure virtual]

Retrieve the URI corresponding to a namespace prefix.

Parameters:
prefix prefix for a namespace
Returns:
URI corresponding to namespace

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::getNodeSetByKey ( XalanNode context,
const XalanQName qname,
const XalanDOMString ref,
const Locator *  locator,
MutableNodeRefList nodelist 
) [pure virtual]

Given a valid element key, return the corresponding node list.

Parameters:
context context node
name qname of the key, which must match the 'name' attribute on xsl:key
ref value that must match the value found by the 'match' attribute on xsl:key
locator The Locator to use for error reporting. Can be 0.
nodelist A node list to contain the nodes found

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::getNodeSetByKey ( XalanNode context,
const XalanDOMString name,
const XalanDOMString ref,
const Locator *  locator,
MutableNodeRefList nodelist 
) [pure virtual]

Given a valid element key, return the corresponding node list.

Parameters:
context context node
name name of the key, which must match the 'name' attribute on xsl:key. Will be resolved to a qname using the provided resolver.
ref value that must match the value found by the 'match' attribute on xsl:key
locator The Locator to use for error reporting. Can be 0.
nodelist A node list to contain the nodes found

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual const PrefixResolver* XPathExecutionContext::getPrefixResolver (  )  const [pure virtual]

Retrieve the resolver for namespaces.

Returns:
object for namespace resolution

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual XalanDocument* XPathExecutionContext::getSourceDocument ( const XalanDOMString theURI  )  const [pure virtual]

Get the document associated with the given URI.

Parameters:
theURI document URI
Returns:
a pointer to the document instance, if any.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual const XalanDOMString& XPathExecutionContext::getUnparsedEntityURI ( const XalanDOMString theName,
const XalanDocument theDocument 
) const [pure virtual]

The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]).

It returns the empty string if there is no such entity.

Parameters:
theName name of entity
theDocument document containing entity
Returns:
URI for the entity

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual const XObjectPtr XPathExecutionContext::getVariable ( const XalanQName name,
const Locator *  locator = 0 
) [pure virtual]

Given a name, locate a variable in the current context, and return a pointer to the object.

Parameters:
theName name of variable
Returns:
An XObjectPtr instance. If the variable is not found, an exception is thrown, or the routine returns an instance of XUnknown.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

XObjectFactory& XPathExecutionContext::getXObjectFactory (  )  const [inline]

Retrieve the factory object for creating XObjects.

Returns:
factory object instance

Definition at line 152 of file XPathExecutionContext.hpp.

virtual bool XPathExecutionContext::isNodeAfter ( const XalanNode node1,
const XalanNode node2 
) const [pure virtual]

Determine if a node is after another node, in document order.

Parameters:
node1 The first node
node2 The second node
Returns:
true if node1 one is after node2, or false if it is not.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual XalanDocument* XPathExecutionContext::parseXML ( MemoryManager &  theManager,
const XalanDOMString urlString,
const XalanDOMString base,
ErrorHandler *  theErrorHandler = 0 
) const [pure virtual]

Provides support for XML parsing service.

Parameters:
theManager The MemoryManager instance to use.
urlString location of the XML
base base location for URI
theErrorHandler An optional ErrorHandler instance for error reporting.
Returns:
parsed document

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::popContextNodeList (  )  [pure virtual]

Pop the node list for current context.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::popCurrentNode (  )  [pure virtual]

Reset the node currently being executed.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::problem ( eSource  source,
eClassification  classification,
const XalanDOMString msg,
const XalanNode sourceNode 
) [pure virtual]

Function that is called when a problem event occurs.

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

Parameters:
source either eXMLPARSER, eXSLPROCESSOR, or eXPATH
classification either eMESSAGE, eERROR or eWARNING
msg string message explaining the problem.

Implements ExecutionContext.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::problem ( eSource  source,
eClassification  classification,
const XalanDOMString msg,
const Locator *  locator,
const XalanNode sourceNode 
) [pure virtual]

Function that is called when a problem event occurs.

Parameters:
source Either eXMLParser, eXSLProcessor, or eXPATH.
classification Either eMessage, eWarning, or eError.
locator The current Locator instance for the stylesheet. Maybe be a null pointer.
sourceNode The current source node, if any.
msg The error message.

Implements ExecutionContext.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::pushContextNodeList ( const NodeRefListBase theList  )  [pure virtual]

Push the node list for current context.

Parameters:
theList new node list

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::pushCurrentNode ( XalanNode theCurrentNode  )  [pure virtual]

Change the node currently being executed.

Parameters:
theCurrentNode new current node

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual bool XPathExecutionContext::releaseCachedString ( XalanDOMString theString  )  [pure virtual]

Return a cached string.

Parameters:
theString The string to release.
Returns:
true if the string was released successfully.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::reset (  )  [pure virtual]

Reset the instance.

This must be called before another execution is attempted.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual bool XPathExecutionContext::returnMutableNodeRefList ( MutableNodeRefList theList  )  [pure virtual]

Return a previously borrowed MutableNodeRefList instance.

Parameters:
theList A pointer the to previously borrowed instance.
Returns:
true if the list was borrowed (at therefore, destroyed), false if not.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::setPrefixResolver ( const PrefixResolver thePrefixResolver  )  [pure virtual]

Change the resolver for namespaces.

Parameters:
thePrefixResolver new object for namespace resolution

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual void XPathExecutionContext::setSourceDocument ( const XalanDOMString theURI,
XalanDocument theDocument 
) [pure virtual]

Associate a document with a given URI.

Parameters:
theURI document URI
theDocument source document

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.

virtual bool XPathExecutionContext::shouldStripSourceNode ( const XalanText node  )  [pure virtual]

Determine if a text node should be stripped from the source tree, as if it weren't there.

Parameters:
textNode text node from the source tree
Returns:
true if the text node should be stripped

Implements ExecutionContext.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, and XPathExecutionContextDefault.


Member Data Documentation

Definition at line 725 of file XPathExecutionContext.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