Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / classXPathProcessor.html
blob: 2df735f2f8506d32daf60e0b25a04285b5d8f05e [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>XPathProcessor Class Reference</h1><code>#include &lt;<a class="el" href="XPathProcessor_8hpp-source.html">XPathProcessor.hpp</a>&gt;</code>
<p>
Inheritance diagram for XPathProcessor:<p><center><img src="classXPathProcessor__inherit__graph.gif" border="0" usemap="#XPathProcessor_inherit_map" alt="Inheritance graph"></center>
<map name="XPathProcessor_inherit_map">
<area href="classXPathProcessorImpl.html" shape="rect" coords="7,117,142,93">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXPathProcessor-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef XERCES_CPP_NAMESPACE_QUALIFIER <br>
Locator <a class="el" href="classXPathProcessor.html#s0">LocatorType</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXPathProcessor.html#a0">XPathProcessor</a> ()
<li>virtual <a class="el" href="classXPathProcessor.html#a1">~XPathProcessor</a> ()
<li>virtual void <a class="el" href="classXPathProcessor.html#a2">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 <a class="el" href="classXPathProcessor.html#s0">LocatorType</a> *locator=0, bool allowVariableReferences=true, bool allowKeyFunction=true)=0
<dl class="el"><dd><font size=-1><em>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.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXPathProcessor.html#a3">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 <a class="el" href="classXPathProcessor.html#s0">LocatorType</a> *locator=0, bool allowVariableReferences=true, bool allowKeyFunction=true)=0
<dl class="el"><dd><font size=-1><em>Given a string, create an XSLT Match Pattern object.</em> <a href="#a3">More...</a><em><br><br></em></font></dl></ul>
<h2>Static Public Methods</h2>
<ul>
<li>void <a class="el" href="classXPathProcessor.html#d0">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><font size=-1><em>Given a string, and a reference to a function object, install the function with the given name.</em> <a href="#d0">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="XPathProcessor::LocatorType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator XPathProcessor::LocatorType
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XPathProcessor::XPathProcessor"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XPathProcessor::XPathProcessor (
</b></td>
<td valign="bottom"><b>
)<code> [explicit]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="XPathProcessor::~XPathProcessor"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XPathProcessor::~XPathProcessor (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="XPathProcessor::initMatchPattern"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XPathProcessor::initMatchPattern (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXPath.html">XPath</a> &amp; <em>pathObj</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXPathConstructionContext.html">XPathConstructionContext</a> &amp; <em>constructionContext</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>expression</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classPrefixResolver.html">PrefixResolver</a> &amp; <em>resolver</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXPathProcessor.html#s0">LocatorType</a> * <em>locator</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>allowVariableReferences</em> = true,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>allowKeyFunction</em> = true&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Given a string, create an XSLT Match Pattern object.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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><em>constructionContext</em>
&nbsp;</td><td>
The construction context </td></tr>
<tr><td valign=top><em>expression</em>
&nbsp;</td><td>
expression that will be evaluated </td></tr>
<tr><td valign=top><em>resolver</em>
&nbsp;</td><td>
prefix resolver to use </td></tr>
<tr><td valign=top><em>locator</em>
&nbsp;</td><td>
the LocatorType to use for error report. May be null </td></tr>
<tr><td valign=top><em>allowVariableReferences</em>
&nbsp;</td><td>
If true, variable references are allowed. </td></tr>
<tr><td valign=top><em>allowKeyFunction</em>
&nbsp;</td><td>
If true, calls to the key() function are allowed. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classXPathProcessorImpl.html#a3">XPathProcessorImpl</a>. </td>
</tr>
</table>
<a name="a2" doxytag="XPathProcessor::initXPath"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XPathProcessor::initXPath (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXPath.html">XPath</a> &amp; <em>pathObj</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXPathConstructionContext.html">XPathConstructionContext</a> &amp; <em>constructionContext</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>expression</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classPrefixResolver.html">PrefixResolver</a> &amp; <em>resolver</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXPathProcessor.html#s0">LocatorType</a> * <em>locator</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>allowVariableReferences</em> = true,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>allowKeyFunction</em> = true&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<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 compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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><em>constructionContext</em>
&nbsp;</td><td>
The construction context </td></tr>
<tr><td valign=top><em>expression</em>
&nbsp;</td><td>
expression that will be evaluated </td></tr>
<tr><td valign=top><em>resolver</em>
&nbsp;</td><td>
prefix resolver to use </td></tr>
<tr><td valign=top><em>locator</em>
&nbsp;</td><td>
the LocatorType to use for error report. May be null </td></tr>
<tr><td valign=top><em>allowVariableReferences</em>
&nbsp;</td><td>
If true, variable references are allowed. </td></tr>
<tr><td valign=top><em>allowKeyFunction</em>
&nbsp;</td><td>
If true, calls to the key() function are allowed. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classXPathProcessorImpl.html#a2">XPathProcessorImpl</a>. </td>
</tr>
</table>
<a name="d0" doxytag="XPathProcessor::installFunction"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XPathProcessor::installFunction (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theFunctionName</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classFunction.html">Function</a> &amp; <em>theFunction</em>&nbsp;)<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Given a string, and a reference to a function object, install the function with the given name.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theFunctionName</em>
&nbsp;</td><td>
name of function </td></tr>
<tr><td valign=top><em>theFunction</em>
&nbsp;</td><td>
function object corresponding to name </td></tr>
</table>
</dl> </td>
</tr>
</table>
<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></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">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="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<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.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>