Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / classKeyDeclaration.html
blob: 3fcb94564aacede76163fff3570ca844ca2e149c [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>KeyDeclaration Class Reference</h1>Holds the attribute declarations for the "xsl:key" element.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="KeyDeclaration_8hpp-source.html">KeyDeclaration.hpp</a>&gt;</code>
<p>
Collaboration diagram for KeyDeclaration:<p><center><img src="classKeyDeclaration__coll__graph.gif" border="0" usemap="#KeyDeclaration_coll_map" alt="Collaboration graph"></center>
<map name="KeyDeclaration_coll_map">
<area href="classXalanDOMString.html" shape="rect" coords="39,146,156,122">
<area href="classXalanQName.html" shape="rect" coords="85,237,181,213">
<area href="classXPath.html" shape="rect" coords="207,237,260,213">
<area href="classXPathFunctionTable.html" shape="rect" coords="289,146,422,122">
<area href="classFunction.html" shape="rect" coords="223,42,289,18">
<area href="structXPathFunctionTable_1_1FunctionNameTableEntry.html" shape="rect" coords="313,42,598,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classKeyDeclaration-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classKeyDeclaration.html#a0">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, <a class="el" href="XalanMap_8hpp.html#a1">XalanLocator::size_type</a> lineNumber, <a class="el" href="XalanMap_8hpp.html#a1">XalanLocator::size_type</a> columnNumber)
<dl class="el"><dd><font size=-1><em>Construct an object containing attributes of an "xsl:key" element.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classKeyDeclaration.html#a1">KeyDeclaration</a> ()
<li><a class="el" href="classKeyDeclaration.html#a2">KeyDeclaration</a> (const KeyDeclaration &amp;theSource)
<li><a class="el" href="classKeyDeclaration.html#a3">~KeyDeclaration</a> ()
<li>const <a class="el" href="classXalanQName.html">XalanQName</a>* <a class="el" href="classKeyDeclaration.html#a4">getQName</a> () const
<dl class="el"><dd><font size=-1><em>Retrieves name of element.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXPath.html">XPath</a>* <a class="el" href="classKeyDeclaration.html#a5">getUse</a> () const
<dl class="el"><dd><font size=-1><em>Retrieves "use" <a class="el" href="classXPath.html">XPath</a>.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXPath.html">XPath</a>* <a class="el" href="classKeyDeclaration.html#a6">getMatchPattern</a> () const
<dl class="el"><dd><font size=-1><em>Retrieves "match" <a class="el" href="classXPath.html">XPath</a>.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>* <a class="el" href="classKeyDeclaration.html#a7">getURI</a> () const
<dl class="el"><dd><font size=-1><em>Retrieves the URI.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li><a class="el" href="XalanMap_8hpp.html#a1">XalanLocator::size_type</a> <a class="el" href="classKeyDeclaration.html#a8">getLineNumber</a> () const
<dl class="el"><dd><font size=-1><em>Retrieves the line number where the xsl:key element occurred.</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li><a class="el" href="XalanMap_8hpp.html#a1">XalanLocator::size_type</a> <a class="el" href="classKeyDeclaration.html#a9">getColumnNumber</a> () const
<dl class="el"><dd><font size=-1><em>Retrieves the column number where the xsl:key element occurred.</em> <a href="#a9">More...</a><em><br><br></em></font></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Holds the attribute declarations for the "xsl:key" element.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="KeyDeclaration::KeyDeclaration"></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>
KeyDeclaration::KeyDeclaration (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> &amp; <em>qname</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXPath.html">XPath</a> &amp; <em>matchPattern</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXPath.html">XPath</a> &amp; <em>use</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>uri</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMap_8hpp.html#a1">XalanLocator::size_type</a> <em>lineNumber</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMap_8hpp.html#a1">XalanLocator::size_type</a> <em>columnNumber</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct an object containing attributes of an "xsl:key" element.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>qname</em>
&nbsp;</td><td>
name of element </td></tr>
<tr><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><em>use</em>
&nbsp;</td><td>
<a class="el" href="classXPath.html">XPath</a> for "use" attribute </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="KeyDeclaration::KeyDeclaration"></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>
KeyDeclaration::KeyDeclaration (
</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="a2" doxytag="KeyDeclaration::KeyDeclaration"></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>
KeyDeclaration::KeyDeclaration (
</b></td>
<td valign="bottom"><b>
const KeyDeclaration &amp; <em>theSource</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="a3" doxytag="KeyDeclaration::~KeyDeclaration"></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>
KeyDeclaration::~KeyDeclaration (
</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>
<hr><h2>Member Function Documentation</h2>
<a name="a9" doxytag="KeyDeclaration::getColumnNumber"></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="XalanMap_8hpp.html#a1">XalanLocator::size_type</a> KeyDeclaration::getColumnNumber (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieves the column number where the xsl:key element occurred.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
The column number </dl> </td>
</tr>
</table>
<a name="a8" doxytag="KeyDeclaration::getLineNumber"></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="XalanMap_8hpp.html#a1">XalanLocator::size_type</a> KeyDeclaration::getLineNumber (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieves the line number where the xsl:key element occurred.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
The line number </dl> </td>
</tr>
</table>
<a name="a6" doxytag="KeyDeclaration::getMatchPattern"></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="classXPath.html">XPath</a> * KeyDeclaration::getMatchPattern (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieves "match" <a class="el" href="classXPath.html">XPath</a>.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
<a class="el" href="classXPath.html">XPath</a> for "match" attribute </dl> </td>
</tr>
</table>
<a name="a4" doxytag="KeyDeclaration::getQName"></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="classXalanQName.html">XalanQName</a> * KeyDeclaration::getQName (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieves name of element.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
name string </dl> </td>
</tr>
</table>
<a name="a7" doxytag="KeyDeclaration::getURI"></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> * KeyDeclaration::getURI (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieves the URI.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
A pointer to a URI string. </dl> </td>
</tr>
</table>
<a name="a5" doxytag="KeyDeclaration::getUse"></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="classXPath.html">XPath</a> * KeyDeclaration::getUse (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieves "use" <a class="el" href="classXPath.html">XPath</a>.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
<a class="el" href="classXPath.html">XPath</a> for "use" attribute </dl> </td>
</tr>
</table>
<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></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>