Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / classFunctionSubstring.html
blob: b973c284b54ab7201b5d6bc7a30b8975bb4e891f [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="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>FunctionSubstring Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="FunctionSubstring" --><!-- doxytag: inherits="Function" -->
<p><a class="el" href="classXPath.html">XPath</a> implementation of "substring" function.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="FunctionSubstring_8hpp_source.html">FunctionSubstring.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classFunction.html">Function</a>.</p>
<div class="dynheader">
Collaboration diagram for FunctionSubstring:</div>
<div class="dyncontent">
<div class="center"><img src="classFunctionSubstring__coll__graph.png" border="0" usemap="#FunctionSubstring_coll__map" alt="Collaboration graph"/></div>
<map name="FunctionSubstring_coll__map" id="FunctionSubstring_coll__map">
<area shape="rect" id="node2" href="classFunction.html" title="Function" alt="" coords="163,413,237,443"/><area shape="rect" id="node4" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types." alt="" coords="261,413,352,443"/><area shape="rect" id="node6" href="classXObject.html" title="Class to hold XPath return types." alt="" coords="271,317,343,347"/><area shape="rect" id="node8" href="classXalanReferenceCountedObject.html" title="Class to hold reference count information." alt="" coords="5,101,224,131"/><area shape="rect" id="node10" href="classXObjectFactory.html" title="This class handles the creation of XObjects and manages their lifetime." alt="" coords="248,101,365,131"/><area shape="rect" id="node12" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="389,101,517,131"/><area shape="rect" id="node14" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="340,5,567,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classFunctionSubstring-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classFunction.html">Function</a> <a class="el" href="classFunctionSubstring.html#afb0696c49bea30d511a6ec3423193980">ParentType</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classFunctionSubstring.html#a2017cf2ce5024043c199440e1c6770c8">FunctionSubstring</a> ()
<li>virtual <a class="el" href="classFunctionSubstring.html#aa1368b6613a0ec5f641d42599b272af8">~FunctionSubstring</a> ()
<li>virtual <a class="el" href="classXObjectPtr.html">XObjectPtr</a> <a class="el" href="classFunctionSubstring.html#acb650cebaacaa50d372ebed74d65e53d">execute</a> (<a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a> &amp;executionContext, <a class="el" href="classXalanNode.html">XalanNode</a> *context, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> arg1, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> arg2, const Locator *locator) const
<dl class="el"><dd class="mdescRight">Execute an <a class="el" href="classXPath.html">XPath</a> function object. <a href="#acb650cebaacaa50d372ebed74d65e53d"></a><br/></dl><li>virtual <a class="el" href="classXObjectPtr.html">XObjectPtr</a> <a class="el" href="classFunctionSubstring.html#ad24305214be081b87b9e767a375b92c8">execute</a> (<a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a> &amp;executionContext, <a class="el" href="classXalanNode.html">XalanNode</a> *context, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> arg1, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> arg2, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> arg3, const Locator *locator) const
<dl class="el"><dd class="mdescRight">Execute an <a class="el" href="classXPath.html">XPath</a> function object. <a href="#ad24305214be081b87b9e767a375b92c8"></a><br/></dl><li>virtual <a class="el" href="classFunctionSubstring.html">FunctionSubstring</a> * <a class="el" href="classFunctionSubstring.html#a4fee24be5259b43eabb1f0ffcd9c38eb">clone</a> (MemoryManager &amp;theManager) const
<dl class="el"><dd class="mdescRight">Create a copy of the function object. <a href="#a4fee24be5259b43eabb1f0ffcd9c38eb"></a><br/></dl></ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <a class="el" href="classFunctionSubstring.html#a4df042e9eb1c5b48dbafa2582897dd78">getError</a> (<a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;<a class="el" href="XalanDOMString_8hpp.html#ad0987a2085caff760532b7f16b5c6f2e">theResult</a>) const
<dl class="el"><dd class="mdescRight">Get the error message to report when the function is called with the wrong number of arguments. <a href="#a4df042e9eb1c5b48dbafa2582897dd78"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classXPath.html">XPath</a> implementation of "substring" function. </p>
<p>Definition at line <a class="el" href="FunctionSubstring_8hpp_source.html#l00048">48</a> of file <a class="el" href="FunctionSubstring_8hpp_source.html">FunctionSubstring.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="afb0696c49bea30d511a6ec3423193980"></a><!-- doxytag: member="FunctionSubstring::ParentType" ref="afb0696c49bea30d511a6ec3423193980" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classFunction.html">Function</a> <a class="el" href="classFunction.html">FunctionSubstring::ParentType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FunctionSubstring_8hpp_source.html#l00052">52</a> of file <a class="el" href="FunctionSubstring_8hpp_source.html">FunctionSubstring.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2017cf2ce5024043c199440e1c6770c8"></a><!-- doxytag: member="FunctionSubstring::FunctionSubstring" ref="a2017cf2ce5024043c199440e1c6770c8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FunctionSubstring::FunctionSubstring </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa1368b6613a0ec5f641d42599b272af8"></a><!-- doxytag: member="FunctionSubstring::~FunctionSubstring" ref="aa1368b6613a0ec5f641d42599b272af8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FunctionSubstring::~FunctionSubstring </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="a4fee24be5259b43eabb1f0ffcd9c38eb"></a><!-- doxytag: member="FunctionSubstring::clone" ref="a4fee24be5259b43eabb1f0ffcd9c38eb" args="(MemoryManager &amp;theManager) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFunctionSubstring.html">FunctionSubstring</a>* FunctionSubstring::clone </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a copy of the function object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the new object </dd></dl>
<p>Implements <a class="el" href="classFunction.html#a2fadcb58a8f88f7cff630a30ce16203c">Function</a>.</p>
</div>
</div>
<a class="anchor" id="ad24305214be081b87b9e767a375b92c8"></a><!-- doxytag: member="FunctionSubstring::execute" ref="ad24305214be081b87b9e767a375b92c8" args="(XPathExecutionContext &amp;executionContext, XalanNode *context, const XObjectPtr arg1, const XObjectPtr arg2, const XObjectPtr arg3, const Locator *locator) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXObjectPtr.html">XObjectPtr</a> FunctionSubstring::execute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a> &amp;&nbsp;</td>
<td class="paramname"> <em>executionContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXObjectPtr.html">XObjectPtr</a>&nbsp;</td>
<td class="paramname"> <em>arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXObjectPtr.html">XObjectPtr</a>&nbsp;</td>
<td class="paramname"> <em>arg2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXObjectPtr.html">XObjectPtr</a>&nbsp;</td>
<td class="paramname"> <em>arg3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Locator *&nbsp;</td>
<td class="paramname"> <em>locator</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute an <a class="el" href="classXPath.html">XPath</a> function object. </p>
<p>The function must return a valid object. Called if function has three parameters.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>executionContext</em>&nbsp;</td><td>executing context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>current context node </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arg1</em>&nbsp;</td><td>pointer to <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> arguments </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arg2</em>&nbsp;</td><td>pointer to <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arg3</em>&nbsp;</td><td>pointer to <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locator</em>&nbsp;</td><td>Locator instance for the <a class="el" href="classXPath.html">XPath</a> expression that contains the function call </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the result <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classFunction.html#adb321088aef6b80affffe9682d95b338">Function</a>.</p>
</div>
</div>
<a class="anchor" id="acb650cebaacaa50d372ebed74d65e53d"></a><!-- doxytag: member="FunctionSubstring::execute" ref="acb650cebaacaa50d372ebed74d65e53d" args="(XPathExecutionContext &amp;executionContext, XalanNode *context, const XObjectPtr arg1, const XObjectPtr arg2, const Locator *locator) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXObjectPtr.html">XObjectPtr</a> FunctionSubstring::execute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a> &amp;&nbsp;</td>
<td class="paramname"> <em>executionContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXObjectPtr.html">XObjectPtr</a>&nbsp;</td>
<td class="paramname"> <em>arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXObjectPtr.html">XObjectPtr</a>&nbsp;</td>
<td class="paramname"> <em>arg2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Locator *&nbsp;</td>
<td class="paramname"> <em>locator</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute an <a class="el" href="classXPath.html">XPath</a> function object. </p>
<p>The function must return a valid object. Called if function has two parameters.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>executionContext</em>&nbsp;</td><td>executing context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>current context node </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arg1</em>&nbsp;</td><td>pointer to <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arg2</em>&nbsp;</td><td>pointer to <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locator</em>&nbsp;</td><td>Locator instance for the <a class="el" href="classXPath.html">XPath</a> expression that contains the function call </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the result <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classFunction.html#a6f66ecef47d99b212cd1caa7c42fec4a">Function</a>.</p>
</div>
</div>
<a class="anchor" id="a4df042e9eb1c5b48dbafa2582897dd78"></a><!-- doxytag: member="FunctionSubstring::getError" ref="a4df042e9eb1c5b48dbafa2582897dd78" args="(XalanDOMString &amp;theResult) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; FunctionSubstring::getError </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theBuffer</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the error message to report when the function is called with the wrong number of arguments. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theBuffer</em>&nbsp;</td><td>The <a class="el" href="classXalanDOMString.html">XalanDOMString</a> for the message. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error message </dd></dl>
<p>Implements <a class="el" href="classFunction.html#a2a9ce8b0b9ec2d6581355346ec84ae30">Function</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FunctionSubstring_8hpp_source.html">FunctionSubstring.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>