Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / xalan-c / apiDocs / classXalanDocumentPrefixResolver.html
blob: 4453084c14814fdc1660690f96d66237106e7c34 [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="#nested-classes">Classes</a> &#124;
<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>XalanDocumentPrefixResolver Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XalanDocumentPrefixResolver" --><!-- doxytag: inherits="PrefixResolver" -->
<p><code>#include &lt;<a class="el" href="XalanDocumentPrefixResolver_8hpp_source.html">XalanDocumentPrefixResolver.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classPrefixResolver.html">PrefixResolver</a>.</p>
<div class="dynheader">
Collaboration diagram for XalanDocumentPrefixResolver:</div>
<div class="dyncontent">
<div class="center"><img src="classXalanDocumentPrefixResolver__coll__graph.png" border="0" usemap="#XalanDocumentPrefixResolver_coll__map" alt="Collaboration graph"/></div>
<map name="XalanDocumentPrefixResolver_coll__map" id="XalanDocumentPrefixResolver_coll__map">
<area shape="rect" id="node2" href="classPrefixResolver.html" title="This class defines an interface for classes that resolve namespace prefixes to their URIs..." alt="" coords="1192,33,1301,63"/><area shape="rect" id="node4" href="classXalanMap.html" title="XalanMap\&lt; const XalanDOMString *, AttributeVectorType \&gt;" alt="" coords="1044,87,1449,116"/><area shape="rect" id="node6" href="classXalanVector.html" title="XalanVector\&lt; BucketType, ConstructWithMemoryManagerTraits\&lt; BucketType \&gt; \&gt;" alt="" coords="359,5,903,35"/><area shape="rect" id="node8" href="structXalanMapKeyTraits_3_01const_01XalanDOMString_01_5_01_4.html" title="XalanMapKeyTraits\&lt; const XalanDOMString * \&gt;" alt="" coords="467,71,795,100"/><area shape="rect" id="node10" href="classXalanList.html" title="XalanList\&lt; Entry \&gt;" alt="" coords="559,133,703,163"/><area shape="rect" id="node12" href="structXalanList_1_1Node.html" title="XalanList\&lt; Type \&gt;::Node" alt="" coords="7,133,188,163"/><area shape="rect" id="node15" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="1183,156,1311,185"/><area shape="rect" id="node17" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="517,187,744,216"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXalanDocumentPrefixResolver-members.html">List of all members.</a></p>
<h2><a name="nested-classes"></a>
Classes</h2>
<ul>
<li>class <a class="el" href="classXalanDocumentPrefixResolver_1_1NamespaceNodesTreeWalker.html">NamespaceNodesTreeWalker</a>
<dl class="el"><dd class="mdescRight">A utility class to walk the <a class="el" href="classXalanDocument.html">XalanDocument</a> instance and look for attribute nodes that declare namespaces. <a href="classXalanDocumentPrefixResolver_1_1NamespaceNodesTreeWalker.html#_details">More...</a><br/></dl></ul>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXalanVector.html">AttributeVectorTypeDecl</a> <a class="el" href="classXalanDocumentPrefixResolver.html#a5d05317a37756ed6d004d05873349c79">AttributeVectorType</a>
<li>typedef <a class="el" href="classXalanMap.html">XalanMap</a>&lt; const <br class="typebreak"/>
<a class="el" href="classXalanDOMString.html">XalanDOMString</a> <br class="typebreak"/>
*, <a class="el" href="classXalanVector.html">AttributeVectorType</a> &gt; <a class="el" href="classXalanDocumentPrefixResolver.html#a5d84d36e7f42bdb9685cb267a5839a19">NamespacesMapType</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXalanDocumentPrefixResolver.html#a1f1c8210513874932cc3f1547aa64c92">XalanDocumentPrefixResolver</a> (const <a class="el" href="classXalanDocument.html">XalanDocument</a> *theDocument, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theURI=<a class="el" href="classXalanDOMString.html">XalanDOMString</a>(XalanMemMgrs::getDummyMemMgr()), MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())
<dl class="el"><dd class="mdescRight">Constructor. <a href="#a1f1c8210513874932cc3f1547aa64c92"></a><br/></dl><li>virtual <a class="el" href="classXalanDocumentPrefixResolver.html#a43e38188d154131c79683adc6019f5aa">~XalanDocumentPrefixResolver</a> ()
<li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> * <a class="el" href="classXalanDocumentPrefixResolver.html#ae88f3197370e35413c0eb4ed643a37b4">getNamespaceForPrefix</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;prefix) const
<dl class="el"><dd class="mdescRight">Retrieve a namespace corresponding to a prefix. <a href="#ae88f3197370e35413c0eb4ed643a37b4"></a><br/></dl><li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <a class="el" href="classXalanDocumentPrefixResolver.html#a596f2494a2cb6928a3441c718f333185">getURI</a> () const
<dl class="el"><dd class="mdescRight">Retrieve the base URI for the resolver. <a href="#a596f2494a2cb6928a3441c718f333185"></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> * <a class="el" href="classXalanDocumentPrefixResolver.html#a9ccc65acdbfdf7b8ee6fb8bd8e3550d4">duplicateBinding</a> (const <a class="el" href="classXalanVector.html">AttributeVectorType</a> &amp;theVector) const
<dl class="el"><dd class="mdescRight">This function is called when more than one binding exists for a given prefix. <a href="#a9ccc65acdbfdf7b8ee6fb8bd8e3550d4"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XalanDocumentPrefixResolver_8hpp_source.html#l00060">60</a> of file <a class="el" href="XalanDocumentPrefixResolver_8hpp_source.html">XalanDocumentPrefixResolver.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a5d05317a37756ed6d004d05873349c79"></a><!-- doxytag: member="XalanDocumentPrefixResolver::AttributeVectorType" ref="a5d05317a37756ed6d004d05873349c79" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">AttributeVectorTypeDecl</a> <a class="el" href="classXalanVector.html">XalanDocumentPrefixResolver::AttributeVectorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanDocumentPrefixResolver_8hpp_source.html#l00064">64</a> of file <a class="el" href="XalanDocumentPrefixResolver_8hpp_source.html">XalanDocumentPrefixResolver.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5d84d36e7f42bdb9685cb267a5839a19"></a><!-- doxytag: member="XalanDocumentPrefixResolver::NamespacesMapType" ref="a5d84d36e7f42bdb9685cb267a5839a19" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanMap.html">XalanMap</a>&lt;const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>*, <a class="el" href="classXalanVector.html">AttributeVectorType</a>&gt; <a class="el" href="classXalanMap.html">XalanDocumentPrefixResolver::NamespacesMapType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanDocumentPrefixResolver_8hpp_source.html#l00066">66</a> of file <a class="el" href="XalanDocumentPrefixResolver_8hpp_source.html">XalanDocumentPrefixResolver.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1f1c8210513874932cc3f1547aa64c92"></a><!-- doxytag: member="XalanDocumentPrefixResolver::XalanDocumentPrefixResolver" ref="a1f1c8210513874932cc3f1547aa64c92" args="(const XalanDocument *theDocument, const XalanDOMString &amp;theURI=XalanDOMString(XalanMemMgrs::getDummyMemMgr()), MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XalanDocumentPrefixResolver::XalanDocumentPrefixResolver </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDocument.html">XalanDocument</a> *&nbsp;</td>
<td class="paramname"> <em>theDocument</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>theURI</em> = <code><a class="el" href="classXalanDOMString.html">XalanDOMString</a>(XalanMemMgrs::getDummyMemMgr())</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em> = <code>XalanMemMgrs::getDefaultXercesMemMgr()</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theDocument</em>&nbsp;</td><td>The <a class="el" href="classXalanDocument.html">XalanDocument</a> instance to use for namespace bindings. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theURI</em>&nbsp;</td><td>The base URI for the instance. This is rarely needed, but can be provided if the URI for the <a class="el" href="classXalanDocument.html">XalanDocument</a> instance is known. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a43e38188d154131c79683adc6019f5aa"></a><!-- doxytag: member="XalanDocumentPrefixResolver::~XalanDocumentPrefixResolver" ref="a43e38188d154131c79683adc6019f5aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XalanDocumentPrefixResolver::~XalanDocumentPrefixResolver </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="a9ccc65acdbfdf7b8ee6fb8bd8e3550d4"></a><!-- doxytag: member="XalanDocumentPrefixResolver::duplicateBinding" ref="a9ccc65acdbfdf7b8ee6fb8bd8e3550d4" args="(const AttributeVectorType &amp;theVector) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>* XalanDocumentPrefixResolver::duplicateBinding </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanVector.html">AttributeVectorType</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theVector</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function is called when more than one binding exists for a given prefix. </p>
<p>The default behavior uses the first binding, but a deriving class can change that behavior by overriding.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theVector</em>&nbsp;</td><td>The vector associated with the namespace prefix. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> containing the desired binding, or NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ae88f3197370e35413c0eb4ed643a37b4"></a><!-- doxytag: member="XalanDocumentPrefixResolver::getNamespaceForPrefix" ref="ae88f3197370e35413c0eb4ed643a37b4" args="(const XalanDOMString &amp;prefix) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>* XalanDocumentPrefixResolver::getNamespaceForPrefix </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>prefix</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a namespace corresponding to a prefix. </p>
<p>This assumes that the PrevixResolver holds its own namespace context, or is a namespace context itself.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prefix</em>&nbsp;</td><td>Prefix to resolve </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>namespace that prefix resolves to, or null if prefix is not found </dd></dl>
<p>Implements <a class="el" href="classPrefixResolver.html#a46238e794270c4d64197bc33f565cd40">PrefixResolver</a>.</p>
</div>
</div>
<a class="anchor" id="a596f2494a2cb6928a3441c718f333185"></a><!-- doxytag: member="XalanDocumentPrefixResolver::getURI" ref="a596f2494a2cb6928a3441c718f333185" args="() 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; XalanDocumentPrefixResolver::getURI </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the base URI for the resolver. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>URI string </dd></dl>
<p>Implements <a class="el" href="classPrefixResolver.html#a7dccfd78c1519de8615042d966fedf04">PrefixResolver</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanDocumentPrefixResolver_8hpp_source.html">XalanDocumentPrefixResolver.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>