Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / xalan-c / apiDocs / classXPathFactory.html
blob: ab4978eb9a528c4d319c29c12d285a4df6db05b6 [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-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>XPathFactory Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XPathFactory" -->
<p><code>#include &lt;<a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>&gt;</code></p>
<p>Inherited by <a class="el" href="classXPathFactoryBlock.html">XPathFactoryBlock</a>, and <a class="el" href="classXPathFactoryDefault.html">XPathFactoryDefault</a>.</p>
<p><a href="classXPathFactory-members.html">List of all members.</a></p>
<h2><a name="nested-classes"></a>
Classes</h2>
<ul>
<li>struct <a class="el" href="structXPathFactory_1_1DeleteXPathFunctor.html">DeleteXPathFunctor</a>
<dl class="el"><dd class="mdescRight">A functor for use with stl algorithms. <a href="structXPathFactory_1_1DeleteXPathFunctor.html#_details">More...</a><br/></dl></ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXPathFactory.html#a52f13a14f8035206ed78b385aea0a189">XPathFactory</a> ()
<li>virtual <a class="el" href="classXPathFactory.html#a46d965c00578c8ad6c01658514385c1e">~XPathFactory</a> ()
<li>bool <a class="el" href="classXPathFactory.html#af6afc5e62efb8803a53e8c15626e952c">returnObject</a> (const <a class="el" href="classXPath.html">XPath</a> *theXPath)
<dl class="el"><dd class="mdescRight">Return an <a class="el" href="classXPath.html">XPath</a> to the factory. <a href="#af6afc5e62efb8803a53e8c15626e952c"></a><br/></dl><li>virtual void <a class="el" href="classXPathFactory.html#af4b6ae4eb8d3ec27628132842ea1b5e0">reset</a> ()=0
<dl class="el"><dd class="mdescRight">Reset the instance. <a href="#af4b6ae4eb8d3ec27628132842ea1b5e0"></a><br/></dl><li>virtual <a class="el" href="classXPath.html">XPath</a> * <a class="el" href="classXPathFactory.html#a71fed111032bbb0b3c2c52f6e4f936c5">create</a> ()=0
<dl class="el"><dd class="mdescRight">Create an <a class="el" href="classXPath.html">XPath</a>. <a href="#a71fed111032bbb0b3c2c52f6e4f936c5"></a><br/></dl></ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li>virtual bool <a class="el" href="classXPathFactory.html#a46ccc6fee03971a615bf2d81ff3ce089">doReturnObject</a> (const <a class="el" href="classXPath.html">XPath</a> *theXPath, bool fInReset=false)=0
</ul>
<h2><a name="friends"></a>
Friends</h2>
<ul>
<li>struct <a class="el" href="classXPathFactory.html#acb0106c826519c6b838232a79cbebe2d">DeleteXPathFunctor</a>
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00041">41</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a52f13a14f8035206ed78b385aea0a189"></a><!-- doxytag: member="XPathFactory::XPathFactory" ref="a52f13a14f8035206ed78b385aea0a189" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPathFactory::XPathFactory </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="a46d965c00578c8ad6c01658514385c1e"></a><!-- doxytag: member="XPathFactory::~XPathFactory" ref="a46d965c00578c8ad6c01658514385c1e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XPathFactory::~XPathFactory </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="a71fed111032bbb0b3c2c52f6e4f936c5"></a><!-- doxytag: member="XPathFactory::create" ref="a71fed111032bbb0b3c2c52f6e4f936c5" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXPath.html">XPath</a>* XPathFactory::create </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an <a class="el" href="classXPath.html">XPath</a>. </p>
<p>The <a class="el" href="classXPath.html">XPath</a> instance is owned by the factory, and should not be deleted. The factory will manage the lifetime. </p>
<p>Implemented in <a class="el" href="classXPathFactoryBlock.html#ac09c19d5e93e89e6176b0b218a79fc95">XPathFactoryBlock</a>, and <a class="el" href="classXPathFactoryDefault.html#a2f387109f36b91033283d5a7fde54c18">XPathFactoryDefault</a>.</p>
</div>
</div>
<a class="anchor" id="a46ccc6fee03971a615bf2d81ff3ce089"></a><!-- doxytag: member="XPathFactory::doReturnObject" ref="a46ccc6fee03971a615bf2d81ff3ce089" args="(const XPath *theXPath, bool fInReset=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool XPathFactory::doReturnObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXPath.html">XPath</a> *&nbsp;</td>
<td class="paramname"> <em>theXPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>fInReset</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classXPathFactoryBlock.html#a0d7fb7037e527928f669fd3411276188">XPathFactoryBlock</a>, and <a class="el" href="classXPathFactoryDefault.html#ae904c428cc8f52ab8367e8c5d02f90ec">XPathFactoryDefault</a>.</p>
</div>
</div>
<a class="anchor" id="af4b6ae4eb8d3ec27628132842ea1b5e0"></a><!-- doxytag: member="XPathFactory::reset" ref="af4b6ae4eb8d3ec27628132842ea1b5e0" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XPathFactory::reset </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset the instance. </p>
<p>This invalidates all existing instances created with this <a class="el" href="classXPathFactory.html">XPathFactory</a>. </p>
<p>Implemented in <a class="el" href="classXPathFactoryBlock.html#a0e76be8676e052a17d401edc1db09b38">XPathFactoryBlock</a>, and <a class="el" href="classXPathFactoryDefault.html#a3d640802d5736f8ad944d89c83705b90">XPathFactoryDefault</a>.</p>
</div>
</div>
<a class="anchor" id="af6afc5e62efb8803a53e8c15626e952c"></a><!-- doxytag: member="XPathFactory::returnObject" ref="af6afc5e62efb8803a53e8c15626e952c" args="(const XPath *theXPath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XPathFactory::returnObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXPath.html">XPath</a> *&nbsp;</td>
<td class="paramname"> <em>theXPath</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return an <a class="el" href="classXPath.html">XPath</a> to the factory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theXPath</em>&nbsp;</td><td>The <a class="el" href="classXPath.html">XPath</a> to be returned </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the object belongs to the factory, false if not. </dd></dl>
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00058">58</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="acb0106c826519c6b838232a79cbebe2d"></a><!-- doxytag: member="XPathFactory::DeleteXPathFunctor" ref="acb0106c826519c6b838232a79cbebe2d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend struct <a class="el" href="structXPathFactory_1_1DeleteXPathFunctor.html">DeleteXPathFunctor</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00120">120</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.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>