Google Git
Sign in
apache / xalan-site / fc63e1a05362d8a54765634eed15aec345e1ef1d / . / content / old / xalan-c / apiDocs / classXPathConstructionContext.html
blob: bfb592c233422d7fa6473dc82d6dd209bdbc748b [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>XPathConstructionContext Class Reference</h1><code>#include &lt;<a class="el" href="XPathConstructionContext_8hpp-source.html">XPathConstructionContext.hpp</a>&gt;</code>
<p>
Inheritance diagram for XPathConstructionContext:<p><center><img src="classXPathConstructionContext__inherit__graph.gif" border="0" usemap="#XPathConstructionContext_inherit_map" alt="Inheritance graph"></center>
<map name="XPathConstructionContext_inherit_map">
<area href="classStylesheetConstructionContext.html" shape="rect" coords="26,117,216,93">
<area href="classXPathConstructionContextDefault.html" shape="rect" coords="240,117,448,93">
<area href="classStylesheetConstructionContextDefault.html" shape="rect" coords="6,192,236,168">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXPathConstructionContext-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXPathConstructionContext_1_1GetAndReleaseCachedString.html">GetAndReleaseCachedString</a> <a class="el" href="classXPathConstructionContext.html#s0">GetCachedString</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXPathConstructionContext.html#a0">XPathConstructionContext</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<li>virtual <a class="el" href="classXPathConstructionContext.html#a1">~XPathConstructionContext</a> ()
<li>virtual void <a class="el" href="classXPathConstructionContext.html#a2">reset</a> ()=0
<dl class="el"><dd><font size=-1><em>Reset the instance.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classXPathConstructionContext.html#a3">getPooledString</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theString)=0
<dl class="el"><dd><font size=-1><em>Get a pooled string given the source string.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classXPathConstructionContext.html#a4">getPooledString</a> (const XalanDOMChar *theString, <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> theLength=XalanDOMString::npos)=0
<dl class="el"><dd><font size=-1><em>Get a pooled string given the source character array.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classXPathConstructionContext.html#a5">getCachedString</a> ()=0
<dl class="el"><dd><font size=-1><em>Get a cached string for temporary use.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classXPathConstructionContext.html#a6">releaseCachedString</a> (<a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theString)=0
<dl class="el"><dd><font size=-1><em>Return a cached string.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li><a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a>&amp; <a class="el" href="classXPathConstructionContext.html#a7">getMemoryManager</a> ()
<li>virtual void <a class="el" href="classXPathConstructionContext.html#a8">error</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;msg, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode, const Locator *locator) const=0
<li>virtual void <a class="el" href="classXPathConstructionContext.html#a9">warn</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;msg, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode, const Locator *locator) const=0
</ul>
<h2>Public Attributes</h2>
<ul>
<li><a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a>&amp; <a class="el" href="classXPathConstructionContext.html#m0">m_memoryManager</a>
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt>
<b>Author: </b><dd>
<a href="mailto:david_n_bertoni@lotus.com">David N. Bertoni</a> </dl>
<p>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="XPathConstructionContext::GetCachedString"></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 <a class="el" href="classXPathConstructionContext_1_1GetAndReleaseCachedString.html">GetAndReleaseCachedString</a> XPathConstructionContext::GetCachedString
</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="XPathConstructionContext::XPathConstructionContext"></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>
XPathConstructionContext::XPathConstructionContext (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;)
</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="XPathConstructionContext::~XPathConstructionContext"></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>
XPathConstructionContext::~XPathConstructionContext (
</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="a8" doxytag="XPathConstructionContext::error"></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 XPathConstructionContext::error (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>msg</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>sourceNode</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const Locator * <em>locator</em>&nbsp;) const<code> [pure 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>
<a name="a5" doxytag="XPathConstructionContext::getCachedString"></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="classXalanDOMString.html">XalanDOMString</a> &amp; XPathConstructionContext::getCachedString (
</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>
Get a cached string for temporary use.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
A reference to the string </dl>
<p>
Reimplemented in <a class="el" href="classXPathConstructionContextDefault.html#a5">XPathConstructionContextDefault</a>, <a class="el" href="classStylesheetConstructionContext.html#a29">StylesheetConstructionContext</a>, and <a class="el" href="classStylesheetConstructionContextDefault.html#a35">StylesheetConstructionContextDefault</a>. </td>
</tr>
</table>
<a name="a7" doxytag="XPathConstructionContext::getMemoryManager"></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="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; XPathConstructionContext::getMemoryManager (
</b></td>
<td valign="bottom"><b>
)
</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="a4" doxytag="XPathConstructionContext::getPooledString"></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>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; XPathConstructionContext::getPooledString (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>theString</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <em>theLength</em> = XalanDOMString::npos&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>
Get a pooled string given the source character array.
<p>
If the string already exists in the pool, no copy will be made. If not, a copy will be made and kept for later use.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theString</em>
&nbsp;</td><td>
The source character array </td></tr>
<tr><td valign=top><em>theLength</em>
&nbsp;</td><td>
The length of the character array </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
a const reference to a pooled string. </dl>
<p>
Reimplemented in <a class="el" href="classXPathConstructionContextDefault.html#a4">XPathConstructionContextDefault</a>, <a class="el" href="classStylesheetConstructionContext.html#a28">StylesheetConstructionContext</a>, and <a class="el" href="classStylesheetConstructionContextDefault.html#a34">StylesheetConstructionContextDefault</a>. </td>
</tr>
</table>
<a name="a3" doxytag="XPathConstructionContext::getPooledString"></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>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; XPathConstructionContext::getPooledString (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theString</em>&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>
Get a pooled string given the source string.
<p>
If the string already exists in the pool, no copy will be made. If not, a copy will be made and kept for later use.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theString</em>
&nbsp;</td><td>
The source string </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
a const reference to a pooled string. </dl>
<p>
Reimplemented in <a class="el" href="classXPathConstructionContextDefault.html#a3">XPathConstructionContextDefault</a>, <a class="el" href="classStylesheetConstructionContext.html#a27">StylesheetConstructionContext</a>, and <a class="el" href="classStylesheetConstructionContextDefault.html#a33">StylesheetConstructionContextDefault</a>. </td>
</tr>
</table>
<a name="a6" doxytag="XPathConstructionContext::releaseCachedString"></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 XPathConstructionContext::releaseCachedString (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theString</em>&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>
Return a cached string.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theString</em>
&nbsp;</td><td>
The string to release.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the string was released successfully. </dl>
<p>
Reimplemented in <a class="el" href="classXPathConstructionContextDefault.html#a6">XPathConstructionContextDefault</a>, <a class="el" href="classStylesheetConstructionContext.html#a30">StylesheetConstructionContext</a>, and <a class="el" href="classStylesheetConstructionContextDefault.html#a36">StylesheetConstructionContextDefault</a>. </td>
</tr>
</table>
<a name="a2" doxytag="XPathConstructionContext::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 XPathConstructionContext::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>
Any existing objects created by the instance will be destroyed.
<p>
Reimplemented in <a class="el" href="classXPathConstructionContextDefault.html#a2">XPathConstructionContextDefault</a>, <a class="el" href="classStylesheetConstructionContext.html#a2">StylesheetConstructionContext</a>, and <a class="el" href="classStylesheetConstructionContextDefault.html#a8">StylesheetConstructionContextDefault</a>. </td>
</tr>
</table>
<a name="a9" doxytag="XPathConstructionContext::warn"></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 XPathConstructionContext::warn (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>msg</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>sourceNode</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const Locator * <em>locator</em>&nbsp;) const<code> [pure 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 Data Documentation</h2>
<a name="m0" doxytag="XPathConstructionContext::m_memoryManager"></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="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; XPathConstructionContext::m_memoryManager
</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="XPathConstructionContext_8hpp-source.html">XPathConstructionContext.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>