Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / classXPathProcessor.html
blob: d1bb8045f97d0954ed92f799f0d19e8d9bbe951f [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="#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>XPathProcessor Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XPathProcessor" -->
<p><code>#include &lt;<a class="el" href="XPathProcessor_8hpp_source.html">XPathProcessor.hpp</a>&gt;</code></p>
<p>Inherited by <a class="el" href="classXPathProcessorImpl.html">XPathProcessorImpl</a>.</p>
<p><a href="classXPathProcessor-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <br class="typebreak"/>
XERCES_CPP_NAMESPACE_QUALIFIER <br class="typebreak"/>
Locator <a class="el" href="classXPathProcessor.html#aa20c25f3c0593a317836e7336e3ace49">LocatorType</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXPathProcessor.html#ae1e1ff5fbf763b8fad05aa40b8b663a9">XPathProcessor</a> ()
<li>virtual <a class="el" href="classXPathProcessor.html#ad2520f39a6d9ca0840f1ed695a886da1">~XPathProcessor</a> ()
<li>virtual void <a class="el" href="classXPathProcessor.html#aa3fe324a7484cb094b7b740c2700a650">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)=0
<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="#aa3fe324a7484cb094b7b740c2700a650"></a><br/></dl><li>virtual void <a class="el" href="classXPathProcessor.html#a20b7f34bbb53d8b0e01e3b62d69271ff">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)=0
<dl class="el"><dd class="mdescRight">Given a string, create an XSLT Match Pattern object. <a href="#a20b7f34bbb53d8b0e01e3b62d69271ff"></a><br/></dl></ul>
<h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2>
<ul>
<li>static void <a class="el" href="classXPathProcessor.html#aa771ee01561539e59e4bf797dc254774">installFunction</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theFunctionName, const <a class="el" href="classFunction.html">Function</a> &amp;theFunction)
<dl class="el"><dd class="mdescRight">Given a string, and a reference to a function object, install the function with the given name. <a href="#aa771ee01561539e59e4bf797dc254774"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XPathProcessor_8hpp_source.html#l00053">53</a> of file <a class="el" href="XPathProcessor_8hpp_source.html">XPathProcessor.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="aa20c25f3c0593a317836e7336e3ace49"></a><!-- doxytag: member="XPathProcessor::LocatorType" ref="aa20c25f3c0593a317836e7336e3ace49" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator <a class="el" href="classXPathProcessor.html#aa20c25f3c0593a317836e7336e3ace49">XPathProcessor::LocatorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathProcessor_8hpp_source.html#l00057">57</a> of file <a class="el" href="XPathProcessor_8hpp_source.html">XPathProcessor.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae1e1ff5fbf763b8fad05aa40b8b663a9"></a><!-- doxytag: member="XPathProcessor::XPathProcessor" ref="ae1e1ff5fbf763b8fad05aa40b8b663a9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPathProcessor::XPathProcessor </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad2520f39a6d9ca0840f1ed695a886da1"></a><!-- doxytag: member="XPathProcessor::~XPathProcessor" ref="ad2520f39a6d9ca0840f1ed695a886da1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XPathProcessor::~XPathProcessor </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="a20b7f34bbb53d8b0e01e3b62d69271ff"></a><!-- doxytag: member="XPathProcessor::initMatchPattern" ref="a20b7f34bbb53d8b0e01e3b62d69271ff" 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)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XPathProcessor::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> [pure 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>Implemented in <a class="el" href="classXPathProcessorImpl.html#afe87ecc4ca4a592a03aef2de212d9cf3">XPathProcessorImpl</a>.</p>
</div>
</div>
<a class="anchor" id="aa3fe324a7484cb094b7b740c2700a650"></a><!-- doxytag: member="XPathProcessor::initXPath" ref="aa3fe324a7484cb094b7b740c2700a650" 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)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XPathProcessor::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> [pure 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>Implemented in <a class="el" href="classXPathProcessorImpl.html#ab8b804dbe69d67acb00002e201e53d15">XPathProcessorImpl</a>.</p>
</div>
</div>
<a class="anchor" id="aa771ee01561539e59e4bf797dc254774"></a><!-- doxytag: member="XPathProcessor::installFunction" ref="aa771ee01561539e59e4bf797dc254774" args="(const XalanDOMString &amp;theFunctionName, const Function &amp;theFunction)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void XPathProcessor::installFunction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theFunctionName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFunction.html">Function</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theFunction</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given a string, and a reference to a function object, install the function with the given name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theFunctionName</em>&nbsp;</td><td>name of function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theFunction</em>&nbsp;</td><td>function object corresponding to name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XPathProcessor_8hpp_source.html">XPathProcessor.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>