Xalan-C++ API Reference
1.12.0
|
#include <xalanc/XPath/XPathExecutionContext.hpp>
Classes | |
class | ContextNodeListPushAndPop |
class | CurrentNodePushAndPop |
class | GetCachedNodeList |
class | GetCachedString |
class | PrefixResolverSetAndRestore |
Public Types | |
typedef XalanVector< XObjectPtr > | XObjectArgVectorType |
typedef NodeRefListBase::size_type | size_type |
typedef GetCachedNodeList | BorrowReturnMutableNodeRefList |
typedef GetCachedString | GetAndReleaseCachedString |
Public Types inherited from xalanc::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 |
Public Member Functions | |
XPathExecutionContext (MemoryManager &theMemoryManager, XObjectFactory *theXObjectFactory=0) | |
virtual | ~XPathExecutionContext () |
virtual void | reset ()=0 |
Reset the instance. More... | |
virtual XalanNode * | getCurrentNode () const =0 |
Retrieve the node currently being executed. More... | |
virtual void | pushCurrentNode (XalanNode *theCurrentNode)=0 |
Change the node currently being executed. More... | |
virtual void | popCurrentNode ()=0 |
Reset the node currently being executed. More... | |
XObjectFactory & | getXObjectFactory () const |
Retrieve the factory object for creating XObjects. More... | |
virtual bool | isNodeAfter (const XalanNode &node1, const XalanNode &node2) const =0 |
Determine if a node is after another node, in document order. More... | |
virtual void | pushContextNodeList (const NodeRefListBase &theList)=0 |
Push the node list for current context. More... | |
virtual void | popContextNodeList ()=0 |
Pop the node list for current context. More... | |
virtual const NodeRefListBase & | getContextNodeList () const =0 |
Get the node list for current context. More... | |
virtual size_type | getContextNodeListLength () const =0 |
virtual size_type | getContextNodeListPosition (const XalanNode &contextNode) const =0 |
virtual bool | elementAvailable (const XalanQName &theQName) const =0 |
Determine if an external element is available. More... | |
virtual bool | elementAvailable (const XalanDOMString &theName, const Locator *locator) const =0 |
Determine if an external element is available by resolving a string to a QName. More... | |
virtual bool | functionAvailable (const XalanQName &theQName) const =0 |
Determine if a function is available. More... | |
virtual bool | functionAvailable (const XalanDOMString &theName, const Locator *locator) const =0 |
Determine if a function is available. More... | |
virtual const XObjectPtr | extFunction (const XalanDOMString &theNamespace, const XalanDOMString &functionName, XalanNode *context, const XObjectArgVectorType &argVec, const Locator *locator)=0 |
Handle an extension function. More... | |
virtual XalanDocument * | parseXML (MemoryManager &theManager, const XalanDOMString &urlString, const XalanDOMString &base, ErrorHandler *theErrorHandler=0) const =0 |
Provides support for XML parsing service. More... | |
virtual MutableNodeRefList * | borrowMutableNodeRefList ()=0 |
Borrow a cached MutableNodeRefList instance. More... | |
virtual bool | returnMutableNodeRefList (MutableNodeRefList *theList)=0 |
Return a previously borrowed MutableNodeRefList instance. More... | |
virtual XalanDOMString & | getCachedString ()=0 |
Get a cached string for temporary use. More... | |
virtual bool | releaseCachedString (XalanDOMString &theString)=0 |
Return a cached string. More... | |
virtual MutableNodeRefList * | createMutableNodeRefList (MemoryManager &theManager) const =0 |
Create a MutableNodeRefList with the appropriate context. More... | |
virtual void | getNodeSetByKey (XalanNode *context, const XalanQName &qname, const XalanDOMString &ref, const Locator *locator, MutableNodeRefList &nodelist)=0 |
Given a valid element key, return the corresponding node list. More... | |
virtual void | getNodeSetByKey (XalanNode *context, const XalanDOMString &name, const XalanDOMString &ref, const Locator *locator, MutableNodeRefList &nodelist)=0 |
Given a valid element key, return the corresponding node list. More... | |
virtual const XObjectPtr | getVariable (const XalanQName &name, const Locator *locator=0)=0 |
Given a name, locate a variable in the current context, and return a pointer to the object. More... | |
virtual const PrefixResolver * | getPrefixResolver () const =0 |
Retrieve the resolver for namespaces. More... | |
virtual void | setPrefixResolver (const PrefixResolver *thePrefixResolver)=0 |
Change the resolver for namespaces. More... | |
virtual const XalanDOMString * | getNamespaceForPrefix (const XalanDOMString &prefix) const =0 |
Retrieve the URI corresponding to a namespace prefix. More... | |
virtual const XalanDOMString & | findURIFromDoc (const XalanDocument *owner) const =0 |
Given a DOM Document, tell what URI was used to parse it. More... | |
virtual const XalanDOMString & | getUnparsedEntityURI (const XalanDOMString &theName, const XalanDocument &theDocument) const =0 |
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]). More... | |
virtual XalanDocument * | getSourceDocument (const XalanDOMString &theURI) const =0 |
Get the document associated with the given URI. More... | |
virtual void | setSourceDocument (const XalanDOMString &theURI, XalanDocument *theDocument)=0 |
Associate a document with a given URI. More... | |
virtual void | formatNumber (double number, const XalanDOMString &pattern, XalanDOMString &theResult, const XalanNode *context=0, const Locator *locator=0)=0 |
Formats a number according to the specified pattern. More... | |
virtual void | formatNumber (double number, const XalanDOMString &pattern, const XalanDOMString &dfsName, XalanDOMString &theResult, const XalanNode *context=0, const Locator *locator=0)=0 |
Formats a number according to the specified pattern. More... | |
virtual void | problem (eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)=0 |
Function that is called when a problem event occurs. More... | |
virtual void | problem (eSource source, eClassification classification, const XalanDOMString &msg, const XalanNode *sourceNode)=0 |
Function that is called when a problem event occurs. More... | |
virtual bool | shouldStripSourceNode (const XalanText &node)=0 |
Determine if a text node should be stripped from the source tree, as if it weren't there. More... | |
Public Member Functions inherited from xalanc::ExecutionContext | |
ExecutionContext (MemoryManager &theMemoryManager) | |
virtual | ~ExecutionContext () |
bool | hasPreserveOrStripSpaceConditions () const |
MemoryManager & | getMemoryManager () const |
MemoryManager & | getExceptionMemoryManager () const |
Public Member Functions inherited from xalanc::ProblemListenerBase | |
ProblemListenerBase () | |
virtual | ~ProblemListenerBase () |
Protected Attributes | |
XObjectFactory * | m_xobjectFactory |
Protected Attributes inherited from xalanc::ExecutionContext | |
MemoryManager & | m_memoryManager |
bool | m_hasPreserveOrStripConditions |
Additional Inherited Members | |
Static Public Member Functions inherited from xalanc::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... | |
Static Protected Attributes inherited from xalanc::ProblemListenerBase | |
static const XalanMessages::Codes | s_messageCodes [eSourceCount][eClassificationCount] |
Definition at line 82 of file XPathExecutionContext.hpp.
Definition at line 428 of file XPathExecutionContext.hpp.
Definition at line 505 of file XPathExecutionContext.hpp.
Definition at line 88 of file XPathExecutionContext.hpp.
Definition at line 86 of file XPathExecutionContext.hpp.
|
explicit |
|
virtual |
|
pure virtual |
Borrow a cached MutableNodeRefList instance.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Create a MutableNodeRefList with the appropriate context.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Determine if an external element is available by resolving a string to a QName.
theName | The name of the element |
locator | A Locator instance for error reporting |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Determine if an external element is available.
theQName | The QName of the element |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Handle an extension function.
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 |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
Referenced by xalanc::XPath::extfunction().
|
pure virtual |
Given a DOM Document, tell what URI was used to parse it.
Needed for relative resolution.
owner | source document |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Formats a number according to the specified pattern.
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 |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Formats a number according to the specified pattern.
number | the number to be formatted |
pattern | the format pattern |
theResult | the formatted number |
context | the source node |
locator | the locator |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Determine if a function is available.
theName | The name of the function |
locator | A Locator instance for error reporting |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Determine if a function is available.
theQName | The QName of the function |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Get a cached string for temporary use.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Get the node list for current context.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
Referenced by xalanc::XPath::functionLast().
|
pure virtual |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
Referenced by xalanc::XPath::functionPosition().
|
pure virtual |
Retrieve the node currently being executed.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
Referenced by xalanc::XPath::execute().
|
pure virtual |
Retrieve the URI corresponding to a namespace prefix.
prefix | prefix for a namespace |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Given a valid element key, return the corresponding node list.
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 xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Given a valid element key, return the corresponding node list.
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 xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Retrieve the resolver for namespaces.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
Referenced by xalanc::XPath::execute().
|
pure virtual |
Get the document associated with the given URI.
theURI | document URI |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
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.
theName | name of entity |
theDocument | document containing entity |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Given a name, locate a variable in the current context, and return a pointer to the object.
theName | name of variable |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
inline |
Retrieve the factory object for creating XObjects.
Definition at line 155 of file XPathExecutionContext.hpp.
|
pure virtual |
Determine if a node is after another node, in document order.
node1 | The first node |
node2 | The second node |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Provides support for XML parsing service.
theManager | The MemoryManager instance to use. |
urlString | location of the XML |
base | base location for URI |
theErrorHandler | An optional ErrorHandler instance for error reporting. |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Pop the node list for current context.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Reset the node currently being executed.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Function that is called when a problem event occurs.
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 xalanc::ExecutionContext.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Function that is called when a problem event occurs.
This version assumes location information is already formatted into the message.
source | either eXMLPARSER, eXSLPROCESSOR, or eXPATH |
classification | either eMESSAGE, eERROR or eWARNING |
msg | string message explaining the problem. |
Implements xalanc::ExecutionContext.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Push the node list for current context.
theList | new node list |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Change the node currently being executed.
theCurrentNode | new current node |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
Referenced by xalanc::XPathExecutionContext::CurrentNodePushAndPop::CurrentNodePushAndPop().
|
pure virtual |
Return a cached string.
theString | The string to release. |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Reset the instance.
This must be called before another execution is attempted.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Return a previously borrowed MutableNodeRefList instance.
theList | A pointer the to previously borrowed instance. |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Change the resolver for namespaces.
thePrefixResolver | new object for namespace resolution |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Associate a document with a given URI.
theURI | document URI |
theDocument | source document |
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
pure virtual |
Determine if a text node should be stripped from the source tree, as if it weren't there.
textNode | text node from the source tree |
Implements xalanc::ExecutionContext.
Implemented in xalanc::StylesheetExecutionContext, xalanc::StylesheetExecutionContextDefault, and xalanc::XPathExecutionContextDefault.
|
protected |
Definition at line 728 of file XPathExecutionContext.hpp.
Copyright © 1999-2020 The Apache Software Foundation. All Rights Reserved.
Generated on Sun May 31 2020 10:37:41 for Xalan-C++ API Reference by 1.8.17