blob: 3076666f96112b93d58c80a82cd8b473f6eec018 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>XPathProcessorImpl Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XPathProcessorImpl" --><!-- doxytag: inherits="XPathProcessor" -->
<p>The <a class="el" href="classXPathProcessorImpl.html" title="The XPathProcessorImpl class responsibilities include tokenizing and parsing the XPath expression...">XPathProcessorImpl</a> class responsibilities include tokenizing and parsing the <a class="el" href="classXPath.html">XPath</a> expression, and acting as a general interface to XPaths.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="XPathProcessorImpl_8hpp_source.html">XPathProcessorImpl.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classXPathProcessor.html">XPathProcessor</a>.</p>
<div class="dynheader">
Collaboration diagram for XPathProcessorImpl:</div>
<div class="dyncontent">
<div class="center"><img src="classXPathProcessorImpl__coll__graph.png" border="0" usemap="#XPathProcessorImpl_coll__map" alt="Collaboration graph"/></div>
<map name="XPathProcessorImpl_coll__map" id="XPathProcessorImpl_coll__map">
<area shape="rect" id="node2" href="classXPathProcessor.html" title="XPathProcessor" alt="" coords="1668,22,1791,52"/><area shape="rect" id="node6" href="classXPathExpression.html" title="XPathExpression" alt="" coords="1056,338,1187,368"/><area shape="rect" id="node22" href="classXPath.html" title="XPath" alt="" coords="1699,290,1760,320"/><area shape="rect" id="node8" href="classXalanVector.html" title="XalanVector\&lt; XToken \&gt;" alt="" coords="403,434,579,464"/><area shape="rect" id="node10" href="classXalanVector.html" title="XalanVector\&lt; int \&gt;" alt="" coords="417,328,564,357"/><area shape="rect" id="node12" href="classXalanVector.html" title="XalanVector\&lt; double \&gt;" alt="" coords="404,381,577,410"/><area shape="rect" id="node14" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="427,248,555,277"/><area shape="rect" id="node16" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="7,248,233,277"/><area shape="rect" id="node18" href="classXPathConstructionContext.html" title="XPathConstructionContext" alt="" coords="1633,160,1825,189"/><area shape="rect" id="node20" href="classProblemListenerBase.html" title="This is the abstract class that is used when reporting a problem some kind, that requires a message..." alt="" coords="1043,157,1200,186"/><area shape="rect" id="node24" href="classXPathFunctionTable.html" title="Class defines a table of functions that can be called in XPath expresions." alt="" coords="1048,449,1195,478"/><area shape="rect" id="node26" href="classFunction.html" title="Function" alt="" coords="453,560,528,589"/><area shape="rect" id="node28" href="structXPathFunctionTable_1_1FunctionNameTableEntry.html" title="XPathFunctionTable::FunctionNameTableEntry" alt="" coords="333,494,648,524"/><area shape="rect" id="node32" href="classPrefixResolver.html" title="This class defines an interface for classes that resolve namespace prefixes to their URIs..." alt="" coords="1675,409,1784,438"/><area shape="rect" id="node34" href="classXalanMap.html" title="XalanMap\&lt; XalanDOMString, const XalanDOMString * \&gt;" alt="" coords="1536,502,1923,532"/><area shape="rect" id="node36" href="classXalanVector.html" title="XalanVector\&lt; BucketType, ConstructWithMemoryManagerTraits\&lt; BucketType \&gt; \&gt;" alt="" coords="849,502,1393,532"/><area shape="rect" id="node38" href="classXalanList.html" title="XalanList\&lt; Entry \&gt;" alt="" coords="1049,573,1193,602"/><area shape="rect" id="node40" href="structXalanList_1_1Node.html" title="XalanList\&lt; Type \&gt;::Node" alt="" coords="400,672,581,701"/><area shape="rect" id="node43" href="structXalanMapKeyTraits_3_01XalanDOMString_01_4.html" title="XalanMapKeyTraits\&lt; XalanDOMString \&gt;" alt="" coords="983,633,1260,662"/><area shape="rect" id="node46" href="classXalanVector.html" title="XalanVector\&lt; bool \&gt;" alt="" coords="1651,556,1808,585"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXPathProcessorImpl-members.html">List of all members.</a></p>
<h2><a name="nested-classes"></a>
Classes</h2>
<ul>
<li>struct <b>TableEntry</b>
</ul>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXalanMap.html">XalanMap</a><br class="typebreak"/>
&lt; <a class="el" href="classXalanDOMString.html">XalanDOMString</a>, const <br class="typebreak"/>
<a class="el" href="classXalanDOMString.html">XalanDOMString</a> * &gt; <a class="el" href="classXPathProcessorImpl.html#ad46d604a3f0036abb802c8ade7616f3e">StringToStringMapType</a>
<li>typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt; bool &gt; <a class="el" href="classXPathProcessorImpl.html#afaf0f3a97b6ac3dce285201e3ef8df35">BoolVectorType</a>
<li>typedef <a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> <a class="el" href="classXPathProcessorImpl.html#a41bc69940b4595f10889bcc341b3ca12">t_size_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXPathProcessorImpl.html#a5f4e65c55a892a6e0dc92430b73a65ad">XPathProcessorImpl</a> (MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())
<li>virtual <a class="el" href="classXPathProcessorImpl.html#a03d535cdd503613029129b959f7575d4">~XPathProcessorImpl</a> ()
<li>virtual void <a class="el" href="classXPathProcessorImpl.html#ab8b804dbe69d67acb00002e201e53d15">initXPath</a> (<a class="el" href="classXPath.html">XPath</a> &amp;pathObj, <a class="el" href="classXPathConstructionContext.html">XPathConstructionContext</a> &amp;constructionContext, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;expression, const <a class="el" href="classPrefixResolver.html">PrefixResolver</a> &amp;resolver, const Locator *locator=0, bool allowVariableReferences=true, bool allowKeyFunction=true)
<dl class="el"><dd class="mdescRight">Given a string, make an <a class="el" href="classXPath.html">XPath</a> object, in order that a parse doesn't have to be done each time the expression is executed. <a href="#ab8b804dbe69d67acb00002e201e53d15"></a><br/></dl><li>virtual void <a class="el" href="classXPathProcessorImpl.html#afe87ecc4ca4a592a03aef2de212d9cf3">initMatchPattern</a> (<a class="el" href="classXPath.html">XPath</a> &amp;pathObj, <a class="el" href="classXPathConstructionContext.html">XPathConstructionContext</a> &amp;constructionContext, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;expression, const <a class="el" href="classPrefixResolver.html">PrefixResolver</a> &amp;resolver, const Locator *locator=0, bool allowVariableReferences=true, bool allowKeyFunction=true)
<dl class="el"><dd class="mdescRight">Given a string, create an XSLT Match Pattern object. <a href="#afe87ecc4ca4a592a03aef2de212d9cf3"></a><br/></dl></ul>
<h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classXPathProcessorImpl.html">XPathProcessorImpl</a> * <a class="el" href="classXPathProcessorImpl.html#a7462e2c6913b087c36ed5796e75e4bfa">create</a> (MemoryManager &amp;theManager)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classXPathProcessorImpl.html" title="The XPathProcessorImpl class responsibilities include tokenizing and parsing the XPath expression...">XPathProcessorImpl</a> class responsibilities include tokenizing and parsing the <a class="el" href="classXPath.html">XPath</a> expression, and acting as a general interface to XPaths. </p>
<p>Definition at line <a class="el" href="XPathProcessorImpl_8hpp_source.html#l00066">66</a> of file <a class="el" href="XPathProcessorImpl_8hpp_source.html">XPathProcessorImpl.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="afaf0f3a97b6ac3dce285201e3ef8df35"></a><!-- doxytag: member="XPathProcessorImpl::BoolVectorType" ref="afaf0f3a97b6ac3dce285201e3ef8df35" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt;bool&gt; <a class="el" href="classXalanVector.html">XPathProcessorImpl::BoolVectorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathProcessorImpl_8hpp_source.html#l00073">73</a> of file <a class="el" href="XPathProcessorImpl_8hpp_source.html">XPathProcessorImpl.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad46d604a3f0036abb802c8ade7616f3e"></a><!-- doxytag: member="XPathProcessorImpl::StringToStringMapType" ref="ad46d604a3f0036abb802c8ade7616f3e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanMap.html">XalanMap</a>&lt;<a class="el" href="classXalanDOMString.html">XalanDOMString</a>, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>*&gt; <a class="el" href="classXalanMap.html">XPathProcessorImpl::StringToStringMapType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathProcessorImpl_8hpp_source.html#l00071">71</a> of file <a class="el" href="XPathProcessorImpl_8hpp_source.html">XPathProcessorImpl.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a41bc69940b4595f10889bcc341b3ca12"></a><!-- doxytag: member="XPathProcessorImpl::t_size_type" ref="a41bc69940b4595f10889bcc341b3ca12" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> <a class="el" href="classXPathProcessorImpl.html#a41bc69940b4595f10889bcc341b3ca12">XPathProcessorImpl::t_size_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathProcessorImpl_8hpp_source.html#l00075">75</a> of file <a class="el" href="XPathProcessorImpl_8hpp_source.html">XPathProcessorImpl.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5f4e65c55a892a6e0dc92430b73a65ad"></a><!-- doxytag: member="XPathProcessorImpl::XPathProcessorImpl" ref="a5f4e65c55a892a6e0dc92430b73a65ad" args="(MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPathProcessorImpl::XPathProcessorImpl </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em> = <code>XalanMemMgrs::getDefaultXercesMemMgr()</code></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a03d535cdd503613029129b959f7575d4"></a><!-- doxytag: member="XPathProcessorImpl::~XPathProcessorImpl" ref="a03d535cdd503613029129b959f7575d4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XPathProcessorImpl::~XPathProcessorImpl </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7462e2c6913b087c36ed5796e75e4bfa"></a><!-- doxytag: member="XPathProcessorImpl::create" ref="a7462e2c6913b087c36ed5796e75e4bfa" args="(MemoryManager &amp;theManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classXPathProcessorImpl.html">XPathProcessorImpl</a>* XPathProcessorImpl::create </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="afe87ecc4ca4a592a03aef2de212d9cf3"></a><!-- doxytag: member="XPathProcessorImpl::initMatchPattern" ref="afe87ecc4ca4a592a03aef2de212d9cf3" args="(XPath &amp;pathObj, XPathConstructionContext &amp;constructionContext, const XalanDOMString &amp;expression, const PrefixResolver &amp;resolver, const Locator *locator=0, bool allowVariableReferences=true, bool allowKeyFunction=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XPathProcessorImpl::initMatchPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPath.html">XPath</a> &amp;&nbsp;</td>
<td class="paramname"> <em>pathObj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXPathConstructionContext.html">XPathConstructionContext</a> &amp;&nbsp;</td>
<td class="paramname"> <em>constructionContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>expression</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPrefixResolver.html">PrefixResolver</a> &amp;&nbsp;</td>
<td class="paramname"> <em>resolver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Locator *&nbsp;</td>
<td class="paramname"> <em>locator</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>allowVariableReferences</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>allowKeyFunction</em> = <code>true</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given a string, create an XSLT Match Pattern object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pathObj</em>&nbsp;</td><td><a class="el" href="classXPath.html">XPath</a> object to be initialized </td></tr>
<tr><td valign="top"></td><td valign="top"><em>constructionContext</em>&nbsp;</td><td>The construction context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>expression</em>&nbsp;</td><td>expression that will be evaluated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resolver</em>&nbsp;</td><td>prefix resolver to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locator</em>&nbsp;</td><td>the Locator to use for error report. May be null </td></tr>
<tr><td valign="top"></td><td valign="top"><em>allowVariableReferences</em>&nbsp;</td><td>If true, variable references are allowed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>allowKeyFunction</em>&nbsp;</td><td>If true, calls to the key() function are allowed. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classXPathProcessor.html#a20b7f34bbb53d8b0e01e3b62d69271ff">XPathProcessor</a>.</p>
</div>
</div>
<a class="anchor" id="ab8b804dbe69d67acb00002e201e53d15"></a><!-- doxytag: member="XPathProcessorImpl::initXPath" ref="ab8b804dbe69d67acb00002e201e53d15" args="(XPath &amp;pathObj, XPathConstructionContext &amp;constructionContext, const XalanDOMString &amp;expression, const PrefixResolver &amp;resolver, const Locator *locator=0, bool allowVariableReferences=true, bool allowKeyFunction=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XPathProcessorImpl::initXPath </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPath.html">XPath</a> &amp;&nbsp;</td>
<td class="paramname"> <em>pathObj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXPathConstructionContext.html">XPathConstructionContext</a> &amp;&nbsp;</td>
<td class="paramname"> <em>constructionContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>expression</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPrefixResolver.html">PrefixResolver</a> &amp;&nbsp;</td>
<td class="paramname"> <em>resolver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Locator *&nbsp;</td>
<td class="paramname"> <em>locator</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>allowVariableReferences</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>allowKeyFunction</em> = <code>true</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given a string, make an <a class="el" href="classXPath.html">XPath</a> object, in order that a parse doesn't have to be done each time the expression is executed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pathObj</em>&nbsp;</td><td><a class="el" href="classXPath.html">XPath</a> object to be initialized </td></tr>
<tr><td valign="top"></td><td valign="top"><em>constructionContext</em>&nbsp;</td><td>The construction context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>expression</em>&nbsp;</td><td>expression that will be evaluated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resolver</em>&nbsp;</td><td>prefix resolver to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locator</em>&nbsp;</td><td>the Locator to use for error report. May be null </td></tr>
<tr><td valign="top"></td><td valign="top"><em>allowVariableReferences</em>&nbsp;</td><td>If true, variable references are allowed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>allowKeyFunction</em>&nbsp;</td><td>If true, calls to the key() function are allowed. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classXPathProcessor.html#aa3fe324a7484cb094b7b740c2700a650">XPathProcessor</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XPathProcessorImpl_8hpp_source.html">XPathProcessorImpl.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">GraphViz</a> are
used to generate this API documentation from the Xalan-C header files.</i></font></p>
<table border="0" cellpadding="0" cellspacing="0" width="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>