blob: 6ac5976ba1533687f980fe8d18778aa691977baa [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>XPathFactory Class Reference</h1><code>#include &lt;<a class="el" href="XPathFactory_8hpp-source.html">XPathFactory.hpp</a>&gt;</code>
<p>
Inheritance diagram for XPathFactory:<p><center><img src="classXPathFactory__inherit__graph.gif" border="0" usemap="#XPathFactory_inherit_map" alt="Inheritance graph"></center>
<map name="XPathFactory_inherit_map">
<area href="classXPathFactoryBlock.html" shape="rect" coords="7,117,135,93">
<area href="classXPathFactoryDefault.html" shape="rect" coords="158,117,294,93">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXPathFactory-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXPathFactory.html#a0">XPathFactory</a> ()
<li>virtual <a class="el" href="classXPathFactory.html#a1">~XPathFactory</a> ()
<li>bool <a class="el" href="classXPathFactory.html#a2">returnObject</a> (const <a class="el" href="classXPath.html">XPath</a> *theXPath)
<dl class="el"><dd><font size=-1><em>Return an <a class="el" href="classXPath.html">XPath</a> to the factory.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXPathFactory.html#a3">reset</a> ()=0
<dl class="el"><dd><font size=-1><em>Reset the instance.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXPath.html">XPath</a>* <a class="el" href="classXPathFactory.html#a4">create</a> ()=0
<dl class="el"><dd><font size=-1><em>Create an <a class="el" href="classXPath.html">XPath</a>.</em> <a href="#a4">More...</a><em><br><br></em></font></dl></ul>
<h2>Protected Methods</h2>
<ul>
<li>virtual bool <a class="el" href="classXPathFactory.html#b0">doReturnObject</a> (const <a class="el" href="classXPath.html">XPath</a> *theXPath, bool fInReset=false)=0
</ul>
<h2>Friends</h2>
<ul>
<li>struct <a class="el" href="classXPathFactory.html#l0">DeleteXPathFunctor</a>
</ul>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XPathFactory::XPathFactory"></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>
XPathFactory::XPathFactory (
</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="XPathFactory::~XPathFactory"></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>
XPathFactory::~XPathFactory (
</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="a4" doxytag="XPathFactory::create"></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>
<a class="el" href="classXPath.html">XPath</a> * XPathFactory::create (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create an <a class="el" href="classXPath.html">XPath</a>.
<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>
Reimplemented in <a class="el" href="classXPathFactoryBlock.html#a3">XPathFactoryBlock</a>, and <a class="el" href="classXPathFactoryDefault.html#a3">XPathFactoryDefault</a>. </td>
</tr>
</table>
<a name="b0" doxytag="XPathFactory::doReturnObject"></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>
bool XPathFactory::doReturnObject (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXPath.html">XPath</a> * <em>theXPath</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>fInReset</em> = false&nbsp;)<code> [protected, pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classXPathFactoryBlock.html#b0">XPathFactoryBlock</a>, and <a class="el" href="classXPathFactoryDefault.html#b0">XPathFactoryDefault</a>. </td>
</tr>
</table>
<a name="a3" doxytag="XPathFactory::reset"></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 XPathFactory::reset (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Reset the instance.
<p>
This invalidates all existing instances created with this XPathFactory.
<p>
Reimplemented in <a class="el" href="classXPathFactoryBlock.html#a2">XPathFactoryBlock</a>, and <a class="el" href="classXPathFactoryDefault.html#a2">XPathFactoryDefault</a>. </td>
</tr>
</table>
<a name="a2" doxytag="XPathFactory::returnObject"></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>
bool XPathFactory::returnObject (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXPath.html">XPath</a> * <em>theXPath</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return an <a class="el" href="classXPath.html">XPath</a> to the factory.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theXPath</em>
&nbsp;</td><td>
The <a class="el" href="classXPath.html">XPath</a> to be returned </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the object belongs to the factory, false if not. </dl> </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l0" doxytag="XPathFactory::DeleteXPathFunctor"></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>
struct DeleteXPathFunctor<code> [friend]</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>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XPathFactory_8hpp-source.html">XPathFactory.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>