272 lines
14 KiB
HTML
272 lines
14 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&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.3.9.1 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
|
|
<h1>URIResolver Class Reference</h1>This is an abstract class used to resolve URIs in different ways.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="URIResolver_8hpp-source.html">URIResolver.hpp</a>></code>
|
|
<p>
|
|
Inheritance diagram for URIResolver:<p><center><img src="classURIResolver__inherit__graph.png" border="0" usemap="#URIResolver__inherit__map" alt="Inheritance graph"></center>
|
|
<map name="URIResolver__inherit__map">
|
|
<area href="classxercesc_1_1XMemory.html" shape="rect" coords="5,7,136,31" alt="">
|
|
</map>
|
|
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classURIResolver-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#a0">~URIResolver</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor, does nothing <a href="#a0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#a1">resolveDocument</a> (<a class="el" href="classSequence.html">Sequence</a> &result, const XMLCh *uri, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context, const QueryPathNode *projection)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolve the given uri (and baseUri) to a <a class="el" href="classSequence.html">Sequence</a> (reference parameter). <a href="#a1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#a2">resolveCollection</a> (<a class="el" href="classSequence.html">Sequence</a> &result, const XMLCh *uri, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context, const QueryPathNode *projection)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolve the given uri (and baseUri) to a <a class="el" href="classSequence.html">Sequence</a> (reference parameter). <a href="#a2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#a3">resolveDefaultCollection</a> (<a class="el" href="classSequence.html">Sequence</a> &result, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context, const QueryPathNode *projection)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolve the default collection. <a href="#a3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#a4">putDocument</a> (const <a class="el" href="classRefCountPointer.html">Node::Ptr</a> &document, const XMLCh *uri, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="#a4"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
This is an abstract class used to resolve URIs in different ways.
|
|
<p>
|
|
The user should derive a concrete class from URIResolver, and use the <a class="el" href="classDynamicContext.html#a21">DynamicContext::registerURIResolver()</a> method to add this resolver to the list used by <a class="el" href="classXQilla.html">XQilla</a>.
|
|
<p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="a0" doxytag="URIResolver::~URIResolver"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual URIResolver::~<a class="el" href="classURIResolver.html">URIResolver</a> </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
virtual destructor, does nothing
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="a4" doxytag="URIResolver::putDocument"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual bool URIResolver::putDocument </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const <a class="el" href="classRefCountPointer.html">Node::Ptr</a> & </td>
|
|
<td class="mdname" nowrap> <em>document</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLCh * </td>
|
|
<td class="mdname" nowrap> <em>uri</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="mdname" nowrap> <em>context</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Called with any document that has been updated, to allow the user to save the document in any manner applicable.
|
|
<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 URIResolver successfully handled the <a class="el" href="classURIResolver.html#a4">putDocument()</a> request, the method should return true, otherwise it should return false and subsequent URIResolver objects will be called to handle the document. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a2" doxytag="URIResolver::resolveCollection"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual bool URIResolver::resolveCollection </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classSequence.html">Sequence</a> & </td>
|
|
<td class="mdname" nowrap> <em>result</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLCh * </td>
|
|
<td class="mdname" nowrap> <em>uri</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="mdname" nowrap> <em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const QueryPathNode * </td>
|
|
<td class="mdname" nowrap> <em>projection</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Resolve the given uri (and baseUri) to a <a class="el" href="classSequence.html">Sequence</a> (reference parameter).
|
|
<p>
|
|
If the uri is relative, the base uri can be obtained from the context. If the uri is not handled by this URIResolver, returns false, otherwise returns true. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a3" doxytag="URIResolver::resolveDefaultCollection"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual bool URIResolver::resolveDefaultCollection </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classSequence.html">Sequence</a> & </td>
|
|
<td class="mdname" nowrap> <em>result</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="mdname" nowrap> <em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const QueryPathNode * </td>
|
|
<td class="mdname" nowrap> <em>projection</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Resolve the default collection.
|
|
<p>
|
|
If it is not defined, returns false, otherwise returns true. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a1" doxytag="URIResolver::resolveDocument"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual bool URIResolver::resolveDocument </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classSequence.html">Sequence</a> & </td>
|
|
<td class="mdname" nowrap> <em>result</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLCh * </td>
|
|
<td class="mdname" nowrap> <em>uri</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="mdname" nowrap> <em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const QueryPathNode * </td>
|
|
<td class="mdname" nowrap> <em>projection</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Resolve the given uri (and baseUri) to a <a class="el" href="classSequence.html">Sequence</a> (reference parameter).
|
|
<p>
|
|
If the uri is relative, the base uri can be obtained from the context. If the uri is not handled by this URIResolver, returns false, otherwise returns true. </td>
|
|
</tr>
|
|
</table>
|
|
<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></ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:41 2009 for XQilla Simple API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
|
|
</body>
|
|
</html>
|