XQuilla/docs/simple-api/classURIResolver.html
2020-02-17 22:24:47 +01:00

317 lines
22 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classURIResolver-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">URIResolver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>This is an abstract class used to resolve URIs in different ways.
<a href="classURIResolver.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="URIResolver_8hpp_source.html">URIResolver.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for URIResolver:</div>
<div class="dyncontent">
<div class="center"><img src="classURIResolver__inherit__graph.png" border="0" usemap="#URIResolver_inherit__map" alt="Inheritance graph"/></div>
<map name="URIResolver_inherit__map" id="URIResolver_inherit__map">
<area shape="rect" id="node2" href="classxercesc_1_1XMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete operators to ..." alt="" coords="5,5,136,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aae25c302d6f7dff9db0c08e9a38cbf2f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#aae25c302d6f7dff9db0c08e9a38cbf2f">~URIResolver</a> ()</td></tr>
<tr class="memdesc:aae25c302d6f7dff9db0c08e9a38cbf2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">virtual destructor, does nothing <a href="#aae25c302d6f7dff9db0c08e9a38cbf2f">More...</a><br/></td></tr>
<tr class="separator:aae25c302d6f7dff9db0c08e9a38cbf2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8794725669e322c88a0acbd328a8105"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#ab8794725669e322c88a0acbd328a8105">resolveDocument</a> (<a class="el" href="classSequence.html">Sequence</a> &amp;result, const XMLCh *uri, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context, const QueryPathNode *projection)=0</td></tr>
<tr class="memdesc:ab8794725669e322c88a0acbd328a8105"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve the given uri (and baseUri) to a <a class="el" href="classSequence.html" title="An eagerly evaluated result of a query execution. ">Sequence</a> (reference parameter). <a href="#ab8794725669e322c88a0acbd328a8105">More...</a><br/></td></tr>
<tr class="separator:ab8794725669e322c88a0acbd328a8105"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af94492ad28b27dcb4d86d3f8e7d7c96d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#af94492ad28b27dcb4d86d3f8e7d7c96d">resolveCollection</a> (<a class="el" href="classSequence.html">Sequence</a> &amp;result, const XMLCh *uri, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context, const QueryPathNode *projection)=0</td></tr>
<tr class="memdesc:af94492ad28b27dcb4d86d3f8e7d7c96d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve the given uri (and baseUri) to a <a class="el" href="classSequence.html" title="An eagerly evaluated result of a query execution. ">Sequence</a> (reference parameter). <a href="#af94492ad28b27dcb4d86d3f8e7d7c96d">More...</a><br/></td></tr>
<tr class="separator:af94492ad28b27dcb4d86d3f8e7d7c96d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc76ef26a214dee9b84b7487f91bb64d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#afc76ef26a214dee9b84b7487f91bb64d">resolveDefaultCollection</a> (<a class="el" href="classSequence.html">Sequence</a> &amp;result, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context, const QueryPathNode *projection)=0</td></tr>
<tr class="memdesc:afc76ef26a214dee9b84b7487f91bb64d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve the default collection. <a href="#afc76ef26a214dee9b84b7487f91bb64d">More...</a><br/></td></tr>
<tr class="separator:afc76ef26a214dee9b84b7487f91bb64d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41988c3ea951241a90ebf05832abb8b8"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#a41988c3ea951241a90ebf05832abb8b8">putDocument</a> (const <a class="el" href="classNode.html#aa13b45b39a606756fd18d94a27522c2c">Node::Ptr</a> &amp;document, const XMLCh *uri, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)=0</td></tr>
<tr class="memdesc:a41988c3ea951241a90ebf05832abb8b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called with any document that has been updated, to allow the user to save the document in any manner applicable. <a href="#a41988c3ea951241a90ebf05832abb8b8">More...</a><br/></td></tr>
<tr class="separator:a41988c3ea951241a90ebf05832abb8b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classxercesc_1_1XMemory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classxercesc_1_1XMemory')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classxercesc_1_1XMemory.html">xercesc::XMemory</a></td></tr>
<tr class="memitem:a6f187594d0fb37d1472dacc1a3aad3d9 inherit pub_methods_classxercesc_1_1XMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a6f187594d0fb37d1472dacc1a3aad3d9">operator new</a> (size_t size)</td></tr>
<tr class="memdesc:a6f187594d0fb37d1472dacc1a3aad3d9 inherit pub_methods_classxercesc_1_1XMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides operator new. <a href="#a6f187594d0fb37d1472dacc1a3aad3d9">More...</a><br/></td></tr>
<tr class="separator:a6f187594d0fb37d1472dacc1a3aad3d9 inherit pub_methods_classxercesc_1_1XMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f41eef0d509e5eff717599647942a0f inherit pub_methods_classxercesc_1_1XMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a7f41eef0d509e5eff717599647942a0f">operator new</a> (size_t size, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
<tr class="memdesc:a7f41eef0d509e5eff717599647942a0f inherit pub_methods_classxercesc_1_1XMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method defines a custom operator new, that will use the provided memory manager to perform the allocation. <a href="#a7f41eef0d509e5eff717599647942a0f">More...</a><br/></td></tr>
<tr class="separator:a7f41eef0d509e5eff717599647942a0f inherit pub_methods_classxercesc_1_1XMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6beea8ceedc7e13c15c3a9f8a784396a inherit pub_methods_classxercesc_1_1XMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a6beea8ceedc7e13c15c3a9f8a784396a">operator new</a> (size_t size, void *ptr)</td></tr>
<tr class="memdesc:a6beea8ceedc7e13c15c3a9f8a784396a inherit pub_methods_classxercesc_1_1XMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides placement operator new. <a href="#a6beea8ceedc7e13c15c3a9f8a784396a">More...</a><br/></td></tr>
<tr class="separator:a6beea8ceedc7e13c15c3a9f8a784396a inherit pub_methods_classxercesc_1_1XMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95212a8b8a0e3778c7bf3cf0f0a59aed inherit pub_methods_classxercesc_1_1XMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a95212a8b8a0e3778c7bf3cf0f0a59aed">operator delete</a> (void *p)</td></tr>
<tr class="memdesc:a95212a8b8a0e3778c7bf3cf0f0a59aed inherit pub_methods_classxercesc_1_1XMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides operator delete. <a href="#a95212a8b8a0e3778c7bf3cf0f0a59aed">More...</a><br/></td></tr>
<tr class="separator:a95212a8b8a0e3778c7bf3cf0f0a59aed inherit pub_methods_classxercesc_1_1XMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2335addd6a2bb6cc7bb1df630d05eeb inherit pub_methods_classxercesc_1_1XMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#af2335addd6a2bb6cc7bb1df630d05eeb">operator delete</a> (void *p, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
<tr class="memdesc:af2335addd6a2bb6cc7bb1df630d05eeb inherit pub_methods_classxercesc_1_1XMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method provides a matching delete for the custom operator new. <a href="#af2335addd6a2bb6cc7bb1df630d05eeb">More...</a><br/></td></tr>
<tr class="separator:af2335addd6a2bb6cc7bb1df630d05eeb inherit pub_methods_classxercesc_1_1XMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47791b65820d24581920532a88c37e75 inherit pub_methods_classxercesc_1_1XMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a47791b65820d24581920532a88c37e75">operator delete</a> (void *p, void *ptr)</td></tr>
<tr class="memdesc:a47791b65820d24581920532a88c37e75 inherit pub_methods_classxercesc_1_1XMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method provides a matching delete for the placement new. <a href="#a47791b65820d24581920532a88c37e75">More...</a><br/></td></tr>
<tr class="separator:a47791b65820d24581920532a88c37e75 inherit pub_methods_classxercesc_1_1XMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classxercesc_1_1XMemory"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classxercesc_1_1XMemory')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classxercesc_1_1XMemory.html">xercesc::XMemory</a></td></tr>
<tr class="memitem:ac0d26f65a82ff229bc1e4dbaaac79e84 inherit pro_methods_classxercesc_1_1XMemory"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#ac0d26f65a82ff229bc1e4dbaaac79e84">XMemory</a> ()</td></tr>
<tr class="memdesc:ac0d26f65a82ff229bc1e4dbaaac79e84 inherit pro_methods_classxercesc_1_1XMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected default constructor. <a href="#ac0d26f65a82ff229bc1e4dbaaac79e84">More...</a><br/></td></tr>
<tr class="separator:ac0d26f65a82ff229bc1e4dbaaac79e84 inherit pro_methods_classxercesc_1_1XMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This is an abstract class used to resolve URIs in different ways. </p>
<p>The user should derive a concrete class from <a class="el" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways. ">URIResolver</a>, and use the <a class="el" href="classDynamicContext.html#aeaf54fa468b79effd098ac1d6ae87fdf" title="Register a callback object for resolving URIs. ">DynamicContext::registerURIResolver()</a> method to add this resolver to the list used by <a class="el" href="classXQilla.html" title="Provides factory methods for creating XQQuery and DynamicContext objects. ">XQilla</a>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aae25c302d6f7dff9db0c08e9a38cbf2f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual URIResolver::~URIResolver </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>virtual destructor, does nothing </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a41988c3ea951241a90ebf05832abb8b8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool URIResolver::putDocument </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classNode.html#aa13b45b39a606756fd18d94a27522c2c">Node::Ptr</a> &amp;&#160;</td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *&#160;</td>
<td class="paramname"><em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td>
<td class="paramname"><em>context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called with any document that has been updated, to allow the user to save the document in any manner applicable. </p>
<p>The uri parameter will be the argument to the fn:put() function if that was called with the document - otherwise it will be the document URI of the document. If this <a class="el" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways. ">URIResolver</a> successfully handled the <a class="el" href="classURIResolver.html#a41988c3ea951241a90ebf05832abb8b8" title="Called with any document that has been updated, to allow the user to save the document in any manner ...">putDocument()</a> request, the method should return true, otherwise it should return false and subsequent <a class="el" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways. ">URIResolver</a> objects will be called to handle the document. </p>
</div>
</div>
<a class="anchor" id="af94492ad28b27dcb4d86d3f8e7d7c96d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool URIResolver::resolveCollection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSequence.html">Sequence</a> &amp;&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *&#160;</td>
<td class="paramname"><em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QueryPathNode *&#160;</td>
<td class="paramname"><em>projection</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolve the given uri (and baseUri) to a <a class="el" href="classSequence.html" title="An eagerly evaluated result of a query execution. ">Sequence</a> (reference parameter). </p>
<p>If the uri is relative, the base uri can be obtained from the context. If the uri is not handled by this <a class="el" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways. ">URIResolver</a>, returns false, otherwise returns true. </p>
</div>
</div>
<a class="anchor" id="afc76ef26a214dee9b84b7487f91bb64d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool URIResolver::resolveDefaultCollection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSequence.html">Sequence</a> &amp;&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QueryPathNode *&#160;</td>
<td class="paramname"><em>projection</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolve the default collection. </p>
<p>If it is not defined, returns false, otherwise returns true. </p>
</div>
</div>
<a class="anchor" id="ab8794725669e322c88a0acbd328a8105"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool URIResolver::resolveDocument </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSequence.html">Sequence</a> &amp;&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *&#160;</td>
<td class="paramname"><em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QueryPathNode *&#160;</td>
<td class="paramname"><em>projection</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolve the given uri (and baseUri) to a <a class="el" href="classSequence.html" title="An eagerly evaluated result of a query execution. ">Sequence</a> (reference parameter). </p>
<p>If the uri is relative, the base uri can be obtained from the context. If the uri is not handled by this <a class="el" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways. ">URIResolver</a>, returns false, otherwise returns true. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="URIResolver_8hpp_source.html">URIResolver.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>