blob: feb0d2686b958d666d1187e92a8f03d27ae03346 [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-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>KeyDeclaration Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="KeyDeclaration" -->
<p>Holds the attribute declarations for the "xsl:key" element.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for KeyDeclaration:</div>
<div class="dyncontent">
<div class="center"><img src="classKeyDeclaration__coll__graph.png" border="0" usemap="#KeyDeclaration_coll__map" alt="Collaboration graph"/></div>
<map name="KeyDeclaration_coll__map" id="KeyDeclaration_coll__map">
<area shape="rect" id="node2" href="classXPath.html" title="XPath" alt="" coords="1157,293,1219,323"/><area shape="rect" id="node4" href="classXPathFunctionTable.html" title="Class defines a table of functions that can be called in XPath expresions." alt="" coords="849,83,996,112"/><area shape="rect" id="node6" href="classFunction.html" title="Function" alt="" coords="453,17,528,47"/><area shape="rect" id="node8" href="structXPathFunctionTable_1_1FunctionNameTableEntry.html" title="XPathFunctionTable::FunctionNameTableEntry" alt="" coords="333,83,648,112"/><area shape="rect" id="node10" href="classXPathExpression.html" title="XPathExpression" alt="" coords="857,237,988,267"/><area shape="rect" id="node12" href="classXalanVector.html" title="XalanVector\&lt; XToken \&gt;" alt="" coords="403,136,579,165"/><area shape="rect" id="node14" href="classXalanVector.html" title="XalanVector\&lt; int \&gt;" alt="" coords="417,189,564,219"/><area shape="rect" id="node16" href="classXalanVector.html" title="XalanVector\&lt; double \&gt;" alt="" coords="404,243,577,272"/><area shape="rect" id="node18" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="427,360,555,389"/><area shape="rect" id="node24" href="classXalanQName.html" title="Class to represent a qualified name." alt="" coords="1023,429,1129,459"/><area shape="rect" id="node20" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="7,360,233,389"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classKeyDeclaration-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classKeyDeclaration.html#a66c722fabba589b9806af9afcdf7e41a">KeyDeclaration</a> (const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;qname, const <a class="el" href="classXPath.html">XPath</a> &amp;matchPattern, const <a class="el" href="classXPath.html">XPath</a> &amp;use, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;uri, XalanFileLoc lineNumber, XalanFileLoc columnNumber)
<dl class="el"><dd class="mdescRight">Construct an object containing attributes of an "xsl:key" element. <a href="#a66c722fabba589b9806af9afcdf7e41a"></a><br/></dl><li><a class="el" href="classKeyDeclaration.html#a7037fcfe0373d94f43d7df5de8c0b9a2">KeyDeclaration</a> ()
<li><a class="el" href="classKeyDeclaration.html#aeb8d40c86873345730b26bda563a6fff">KeyDeclaration</a> (const <a class="el" href="classKeyDeclaration.html">KeyDeclaration</a> &amp;theSource)
<li><a class="el" href="classKeyDeclaration.html#a8bd1093058f9eb5a7d565d91eec7de12">~KeyDeclaration</a> ()
<li>const <a class="el" href="classXalanQName.html">XalanQName</a> * <a class="el" href="classKeyDeclaration.html#aa83d3013cfc1b5edec4fb1b444e18e06">getQName</a> () const
<dl class="el"><dd class="mdescRight">Retrieves name of element. <a href="#aa83d3013cfc1b5edec4fb1b444e18e06"></a><br/></dl><li>const <a class="el" href="classXPath.html">XPath</a> * <a class="el" href="classKeyDeclaration.html#a0ad0c8effe0763cef6b29715fba24e8f">getUse</a> () const
<dl class="el"><dd class="mdescRight">Retrieves "use" <a class="el" href="classXPath.html">XPath</a>. <a href="#a0ad0c8effe0763cef6b29715fba24e8f"></a><br/></dl><li>const <a class="el" href="classXPath.html">XPath</a> * <a class="el" href="classKeyDeclaration.html#a6d30c28a519e4804b9cc7ba06f96eae0">getMatchPattern</a> () const
<dl class="el"><dd class="mdescRight">Retrieves "match" <a class="el" href="classXPath.html">XPath</a>. <a href="#a6d30c28a519e4804b9cc7ba06f96eae0"></a><br/></dl><li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> * <a class="el" href="classKeyDeclaration.html#a198a2d6fd67d8afd9ac8a958663eaab0">getURI</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the URI. <a href="#a198a2d6fd67d8afd9ac8a958663eaab0"></a><br/></dl><li>XalanFileLoc <a class="el" href="classKeyDeclaration.html#ad62f04a5acd6ef85edec2386df327c5e">getLineNumber</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the line number where the xsl:key element occurred. <a href="#ad62f04a5acd6ef85edec2386df327c5e"></a><br/></dl><li>XalanFileLoc <a class="el" href="classKeyDeclaration.html#ab8fc6ec32eef3e3eb82b12bcab4099f6">getColumnNumber</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the column number where the xsl:key element occurred. <a href="#ab8fc6ec32eef3e3eb82b12bcab4099f6"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Holds the attribute declarations for the "xsl:key" element. </p>
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00043">43</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a66c722fabba589b9806af9afcdf7e41a"></a><!-- doxytag: member="KeyDeclaration::KeyDeclaration" ref="a66c722fabba589b9806af9afcdf7e41a" args="(const XalanQName &amp;qname, const XPath &amp;matchPattern, const XPath &amp;use, const XalanDOMString &amp;uri, XalanFileLoc lineNumber, XalanFileLoc columnNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeyDeclaration::KeyDeclaration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;&nbsp;</td>
<td class="paramname"> <em>qname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXPath.html">XPath</a> &amp;&nbsp;</td>
<td class="paramname"> <em>matchPattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXPath.html">XPath</a> &amp;&nbsp;</td>
<td class="paramname"> <em>use</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanFileLoc&nbsp;</td>
<td class="paramname"> <em>lineNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanFileLoc&nbsp;</td>
<td class="paramname"> <em>columnNumber</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an object containing attributes of an "xsl:key" element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>qname</em>&nbsp;</td><td>name of element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>matchPattern</em>&nbsp;</td><td><a class="el" href="classXPath.html">XPath</a> for "match" attribute </td></tr>
<tr><td valign="top"></td><td valign="top"><em>use</em>&nbsp;</td><td><a class="el" href="classXPath.html">XPath</a> for "use" attribute </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00054">54</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7037fcfe0373d94f43d7df5de8c0b9a2"></a><!-- doxytag: member="KeyDeclaration::KeyDeclaration" ref="a7037fcfe0373d94f43d7df5de8c0b9a2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeyDeclaration::KeyDeclaration </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00071">71</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aeb8d40c86873345730b26bda563a6fff"></a><!-- doxytag: member="KeyDeclaration::KeyDeclaration" ref="aeb8d40c86873345730b26bda563a6fff" args="(const KeyDeclaration &amp;theSource)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeyDeclaration::KeyDeclaration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKeyDeclaration.html">KeyDeclaration</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theSource</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00081">81</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8bd1093058f9eb5a7d565d91eec7de12"></a><!-- doxytag: member="KeyDeclaration::~KeyDeclaration" ref="a8bd1093058f9eb5a7d565d91eec7de12" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeyDeclaration::~KeyDeclaration </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00088">88</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab8fc6ec32eef3e3eb82b12bcab4099f6"></a><!-- doxytag: member="KeyDeclaration::getColumnNumber" ref="ab8fc6ec32eef3e3eb82b12bcab4099f6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XalanFileLoc KeyDeclaration::getColumnNumber </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the column number where the xsl:key element occurred. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The column number </dd></dl>
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00153">153</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad62f04a5acd6ef85edec2386df327c5e"></a><!-- doxytag: member="KeyDeclaration::getLineNumber" ref="ad62f04a5acd6ef85edec2386df327c5e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XalanFileLoc KeyDeclaration::getLineNumber </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the line number where the xsl:key element occurred. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The line number </dd></dl>
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00142">142</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6d30c28a519e4804b9cc7ba06f96eae0"></a><!-- doxytag: member="KeyDeclaration::getMatchPattern" ref="a6d30c28a519e4804b9cc7ba06f96eae0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXPath.html">XPath</a>* KeyDeclaration::getMatchPattern </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves "match" <a class="el" href="classXPath.html">XPath</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classXPath.html">XPath</a> for "match" attribute </dd></dl>
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00120">120</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa83d3013cfc1b5edec4fb1b444e18e06"></a><!-- doxytag: member="KeyDeclaration::getQName" ref="aa83d3013cfc1b5edec4fb1b444e18e06" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXalanQName.html">XalanQName</a>* KeyDeclaration::getQName </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves name of element. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>name string </dd></dl>
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00098">98</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a198a2d6fd67d8afd9ac8a958663eaab0"></a><!-- doxytag: member="KeyDeclaration::getURI" ref="a198a2d6fd67d8afd9ac8a958663eaab0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>* KeyDeclaration::getURI </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the URI. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a URI string. </dd></dl>
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00131">131</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0ad0c8effe0763cef6b29715fba24e8f"></a><!-- doxytag: member="KeyDeclaration::getUse" ref="a0ad0c8effe0763cef6b29715fba24e8f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXPath.html">XPath</a>* KeyDeclaration::getUse </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves "use" <a class="el" href="classXPath.html">XPath</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classXPath.html">XPath</a> for "use" attribute </dd></dl>
<p>Definition at line <a class="el" href="KeyDeclaration_8hpp_source.html#l00109">109</a> of file <a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="KeyDeclaration_8hpp_source.html">KeyDeclaration.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>