1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
<!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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main 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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>URIResolver Class Reference</h1><!-- doxytag: class="URIResolver" --><!-- doxytag: inherits="xercesc::XMemory" -->
<p>This is an abstract class used to resolve URIs in different ways.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="URIResolver_8hpp_source.html">URIResolver.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for URIResolver:</div>
<div class="dynsection">
<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..." alt="" coords="5,5,155,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classURIResolver-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#aae25c302d6f7dff9db0c08e9a38cbf2f">~URIResolver</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor, does nothing <a href="#aae25c302d6f7dff9db0c08e9a38cbf2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#ab8794725669e322c88a0acbd328a8105">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" title="An eagerly evaluated result of a query execution.">Sequence</a> (reference parameter). <a href="#ab8794725669e322c88a0acbd328a8105"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#af94492ad28b27dcb4d86d3f8e7d7c96d">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" title="An eagerly evaluated result of a query execution.">Sequence</a> (reference parameter). <a href="#af94492ad28b27dcb4d86d3f8e7d7c96d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#afc76ef26a214dee9b84b7487f91bb64d">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="#afc76ef26a214dee9b84b7487f91bb64d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURIResolver.html#a41988c3ea951241a90ebf05832abb8b8">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="#a41988c3ea951241a90ebf05832abb8b8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aae25c302d6f7dff9db0c08e9a38cbf2f"></a><!-- doxytag: member="URIResolver::~URIResolver" ref="aae25c302d6f7dff9db0c08e9a38cbf2f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual URIResolver::~URIResolver </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>virtual destructor, does nothing </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a41988c3ea951241a90ebf05832abb8b8"></a><!-- doxytag: member="URIResolver::putDocument" ref="a41988c3ea951241a90ebf05832abb8b8" args="(const Node::Ptr &document, const XMLCh *uri, DynamicContext *context)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool URIResolver::putDocument </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRefCountPointer.html">Node::Ptr</a> & </td>
<td class="paramname"> <em>document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </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> * </td>
<td class="paramname"> <em>context</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></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...">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><!-- doxytag: member="URIResolver::resolveCollection" ref="af94492ad28b27dcb4d86d3f8e7d7c96d" args="(Sequence &result, const XMLCh *uri, DynamicContext *context, const QueryPathNode *projection)=0" -->
<div class="memitem">
<div class="memproto">
<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> & </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </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> * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QueryPathNode * </td>
<td class="paramname"> <em>projection</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></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><!-- doxytag: member="URIResolver::resolveDefaultCollection" ref="afc76ef26a214dee9b84b7487f91bb64d" args="(Sequence &result, DynamicContext *context, const QueryPathNode *projection)=0" -->
<div class="memitem">
<div class="memproto">
<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> & </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> * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QueryPathNode * </td>
<td class="paramname"> <em>projection</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></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><!-- doxytag: member="URIResolver::resolveDocument" ref="ab8794725669e322c88a0acbd328a8105" args="(Sequence &result, const XMLCh *uri, DynamicContext *context, const QueryPathNode *projection)=0" -->
<div class="memitem">
<div class="memproto">
<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> & </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </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> * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QueryPathNode * </td>
<td class="paramname"> <em>projection</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></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>
<hr size="1"/><address style="text-align: right;"><small>Generated on 18 May 2015 for XQilla Simple API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
