Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / xalan-c / apiDocs / classXalanNamedNodeMap.html
blob: cf47822882ee78893be0298dc2c195a543815af5 [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> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>XalanNamedNodeMap Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XalanNamedNodeMap" -->
<p><code>#include &lt;<a class="el" href="XalanNamedNodeMap_8hpp_source.html">XalanNamedNodeMap.hpp</a>&gt;</code></p>
<p>Inherited by <a class="el" href="classXalanEmptyNamedNodeMap.html">XalanEmptyNamedNodeMap</a>, <a class="el" href="classXalanSourceTreeElementA.html">XalanSourceTreeElementA</a><code> [private]</code>, <a class="el" href="classXercesNamedNodeMapBridge.html">XercesNamedNodeMapBridge</a>, and <a class="el" href="classXercesNamedNodeMapWrapper.html">XercesNamedNodeMapWrapper</a>.</p>
<p><a href="classXalanNamedNodeMap-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXalanNamedNodeMap.html#a48c0df25cdd82e87a42047996062a826">XalanNamedNodeMap</a> ()
<li>virtual <a class="el" href="classXalanNamedNodeMap.html#adb1f39a07f2052d70a261fe18876f6d9">~XalanNamedNodeMap</a> ()
<li>virtual <a class="el" href="classXalanNode.html">XalanNode</a> * <a class="el" href="classXalanNamedNodeMap.html#a2be89c5a133362b3fab5d4cbab60fe8d">item</a> (XalanSize_t index) const =0
<dl class="el"><dd class="mdescRight">Returns the <code>index</code>th item in the map. <a href="#a2be89c5a133362b3fab5d4cbab60fe8d"></a><br/></dl><li>virtual <a class="el" href="classXalanNode.html">XalanNode</a> * <a class="el" href="classXalanNamedNodeMap.html#a7144b7be7ea441b483358f15b5d87983">getNamedItem</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;name) const =0
<dl class="el"><dd class="mdescRight">Retrieves a node specified by name. <a href="#a7144b7be7ea441b483358f15b5d87983"></a><br/></dl><li>virtual XalanSize_t <a class="el" href="classXalanNamedNodeMap.html#ad301588eab728d79de4f44a8266b44f3">getLength</a> () const =0
<dl class="el"><dd class="mdescRight">The number of nodes in the map. <a href="#ad301588eab728d79de4f44a8266b44f3"></a><br/></dl><li>virtual <a class="el" href="classXalanNode.html">XalanNode</a> * <a class="el" href="classXalanNamedNodeMap.html#a83196f399a221e69c204f4f9983a0439">getNamedItemNS</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;namespaceURI, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;localName) const =0
<dl class="el"><dd class="mdescRight">Retrieves a node specified by local name and namespace URI. <a href="#a83196f399a221e69c204f4f9983a0439"></a><br/></dl></ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li><a class="el" href="classXalanNamedNodeMap.html#a9ac1091b35bb81228b7d7e978138732d">XalanNamedNodeMap</a> (const <a class="el" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a> &amp;theSource)
<li><a class="el" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a> &amp; <a class="el" href="classXalanNamedNodeMap.html#a0495bc958f9b6937adc62c8c8ac1730b">operator=</a> (const <a class="el" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a> &amp;theSource)
<li>bool <a class="el" href="classXalanNamedNodeMap.html#ae87ff86f4a113ea49ea27519706bdbf7">operator==</a> (const <a class="el" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a> &amp;theRHS) const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XalanNamedNodeMap_8hpp_source.html#l00036">36</a> of file <a class="el" href="XalanNamedNodeMap_8hpp_source.html">XalanNamedNodeMap.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a48c0df25cdd82e87a42047996062a826"></a><!-- doxytag: member="XalanNamedNodeMap::XalanNamedNodeMap" ref="a48c0df25cdd82e87a42047996062a826" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XalanNamedNodeMap::XalanNamedNodeMap </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="adb1f39a07f2052d70a261fe18876f6d9"></a><!-- doxytag: member="XalanNamedNodeMap::~XalanNamedNodeMap" ref="adb1f39a07f2052d70a261fe18876f6d9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XalanNamedNodeMap::~XalanNamedNodeMap </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9ac1091b35bb81228b7d7e978138732d"></a><!-- doxytag: member="XalanNamedNodeMap::XalanNamedNodeMap" ref="a9ac1091b35bb81228b7d7e978138732d" args="(const XalanNamedNodeMap &amp;theSource)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XalanNamedNodeMap::XalanNamedNodeMap </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theSource</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad301588eab728d79de4f44a8266b44f3"></a><!-- doxytag: member="XalanNamedNodeMap::getLength" ref="ad301588eab728d79de4f44a8266b44f3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XalanSize_t XalanNamedNodeMap::getLength </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The number of nodes in the map. </p>
<p>The range of valid child node indices is 0 to <code>length-1</code> inclusive. </p>
<p>Implemented in <a class="el" href="classXalanEmptyNamedNodeMap.html#a0d117e0f7ca83c9acc0db1fa7db4dad7">XalanEmptyNamedNodeMap</a>, <a class="el" href="classXercesNamedNodeMapWrapper.html#a1cdf1a867158b834c4563a4907342dad">XercesNamedNodeMapWrapper</a>, and <a class="el" href="classXercesNamedNodeMapBridge.html#a68a898d750501e860cdd1291548abb50">XercesNamedNodeMapBridge</a>.</p>
</div>
</div>
<a class="anchor" id="a7144b7be7ea441b483358f15b5d87983"></a><!-- doxytag: member="XalanNamedNodeMap::getNamedItem" ref="a7144b7be7ea441b483358f15b5d87983" args="(const XalanDOMString &amp;name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanNode.html">XalanNode</a>* XalanNamedNodeMap::getNamedItem </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>name</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves a node specified by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The <code>nodeName</code> of a node to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>Node</code> (of any type) with the specified <code>nodeName</code>, or <code>null</code> if it does not identify any node in the map. </dd></dl>
<p>Implemented in <a class="el" href="classXalanEmptyNamedNodeMap.html#a6360d2bcd8f9e0dc5c37484b282d0912">XalanEmptyNamedNodeMap</a>, <a class="el" href="classXercesNamedNodeMapWrapper.html#a1dbf0687ffeb1ac8dbcb2aefdba76426">XercesNamedNodeMapWrapper</a>, and <a class="el" href="classXercesNamedNodeMapBridge.html#a24b5b0021845ce8eb0858748f9b8e1a8">XercesNamedNodeMapBridge</a>.</p>
</div>
</div>
<a class="anchor" id="a83196f399a221e69c204f4f9983a0439"></a><!-- doxytag: member="XalanNamedNodeMap::getNamedItemNS" ref="a83196f399a221e69c204f4f9983a0439" args="(const XalanDOMString &amp;namespaceURI, const XalanDOMString &amp;localName) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanNode.html">XalanNode</a>* XalanNamedNodeMap::getNamedItemNS </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>namespaceURI</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>localName</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves a node specified by local name and namespace URI. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>namespaceURI</em>&nbsp;</td><td>The <em>namespace URI</em> of the node to retrieve. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>localName</em>&nbsp;</td><td>The <em>local name</em> of the node to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>Node</code> (of any type) with the specified local name and namespace URI, or <code>null</code> if they do not identify any node in the map. </dd></dl>
<p>Implemented in <a class="el" href="classXalanEmptyNamedNodeMap.html#a57a202eb79592583a210dd669d1a0e7b">XalanEmptyNamedNodeMap</a>, <a class="el" href="classXercesNamedNodeMapWrapper.html#a190a8f0759e3ff97e3a7dce6c8248414">XercesNamedNodeMapWrapper</a>, and <a class="el" href="classXercesNamedNodeMapBridge.html#a016858630d02e2ae2873df4ed4ae0082">XercesNamedNodeMapBridge</a>.</p>
</div>
</div>
<a class="anchor" id="a2be89c5a133362b3fab5d4cbab60fe8d"></a><!-- doxytag: member="XalanNamedNodeMap::item" ref="a2be89c5a133362b3fab5d4cbab60fe8d" args="(XalanSize_t index) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanNode.html">XalanNode</a>* XalanNamedNodeMap::item </td>
<td>(</td>
<td class="paramtype">XalanSize_t&nbsp;</td>
<td class="paramname"> <em>index</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <code>index</code>th item in the map. </p>
<p>If <code>index</code> is greater than or equal to the number of nodes in the map, this returns <code>null</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>Index into the map. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The node at the <code>index</code>th position in the <code>NamedNodeMap</code>, or <code>null</code> if that is not a valid index. </dd></dl>
<p>Implemented in <a class="el" href="classXalanEmptyNamedNodeMap.html#ab72b8e1ada5fcf9cdd7b0d959eb8ebee">XalanEmptyNamedNodeMap</a>, and <a class="el" href="classXercesNamedNodeMapWrapper.html#aaf432ebf70813f6d07d57f8777578ab1">XercesNamedNodeMapWrapper</a>.</p>
</div>
</div>
<a class="anchor" id="a0495bc958f9b6937adc62c8c8ac1730b"></a><!-- doxytag: member="XalanNamedNodeMap::operator=" ref="a0495bc958f9b6937adc62c8c8ac1730b" args="(const XalanNamedNodeMap &amp;theSource)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a>&amp; XalanNamedNodeMap::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theSource</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae87ff86f4a113ea49ea27519706bdbf7"></a><!-- doxytag: member="XalanNamedNodeMap::operator==" ref="ae87ff86f4a113ea49ea27519706bdbf7" args="(const XalanNamedNodeMap &amp;theRHS) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XalanNamedNodeMap::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theRHS</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanNamedNodeMap_8hpp_source.html">XalanNamedNodeMap.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>