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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
<!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>XML-Security-C: XSECXPathNodeList Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</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="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>XSECXPathNodeList Class Reference<br>
<small>
[<a class="el" href="group__internal.html">Internal Classes</a>]</small>
</h1><code>#include <<a class="el" href="XSECXPathNodeList_8hpp-source.html">XSECXPathNodeList.hpp</a>></code>
<p>
<a href="classXSECXPathNodeList-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Class for holding lists of DOMNodes.
<p>
This class is used primarily for holding lists of nodes found during XPath processing. It is also used for xpath-filter which requires multiple list comparisons.<p>
It is not implemented using one of the container classes as it has the potential to become a real bottleneck. It could potentially be implemented as a hash list based on names of nodes (or even pointers).
<p>
<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 colspan="2"><div class="groupHeader">Constructors, Destructors and operators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z229_0">XSECXPathNodeList</a> (unsigned int initialSize=_XSEC_NODELIST_DEFAULT_SIZE)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z229_1">XSECXPathNodeList</a> (const <a class="el" href="classXSECXPathNodeList.html">XSECXPathNodeList</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy Constructor. <a href="#z229_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z229_2">~XSECXPathNodeList</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXSECXPathNodeList.html">XSECXPathNodeList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z229_3">operator=</a> (const <a class="el" href="classXSECXPathNodeList.html">XSECXPathNodeList</a> &toCopy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment Operator. <a href="#z229_3"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Adding and Deleting nodes</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z230_0">addNode</a> (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a node to the list. <a href="#z230_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z230_1">removeNode</a> (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a node from the list. <a href="#z230_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z230_2">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear out the entire list, deleting all entries. <a href="#z230_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Reading List Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z231_0">hasNode</a> (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a node exists in the list. <a href="#z231_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z231_1">getFirstNode</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the first node in the list. <a href="#z231_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z231_2">getNextNode</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next node in the list. <a href="#z231_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulating Nodesets</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECXPathNodeList.html#z232_0">intersect</a> (const <a class="el" href="classXSECXPathNodeList.html">XSECXPathNodeList</a> &toIntersect)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Intersect with nodeset. <a href="#z232_0"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z229_0" doxytag="XSECXPathNodeList::XSECXPathNodeList"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">XSECXPathNodeList::XSECXPathNodeList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>initialSize</em> = <code>_XSEC_NODELIST_DEFAULT_SIZE</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="z229_1" doxytag="XSECXPathNodeList::XSECXPathNodeList"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">XSECXPathNodeList::XSECXPathNodeList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECXPathNodeList.html">XSECXPathNodeList</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>other</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Copy Constructor.
<p>
<dl compact><dt><b>Note:</b></dt><dd>The XSEC Library generally passes NodeLists around as pointers. There is a LARGE overhead associated with re-creating lists, so we try to avoid doing it unless necessary. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z229_2" doxytag="XSECXPathNodeList::~XSECXPathNodeList"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">XSECXPathNodeList::~XSECXPathNodeList </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z230_0" doxytag="XSECXPathNodeList::addNode"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void XSECXPathNodeList::addNode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname1" valign="top" nowrap> <em>n</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a node to the list.
<p>
Checks to see whether the node is already in the list, and if not adds it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>The node to add. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z230_2" doxytag="XSECXPathNodeList::clear"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void XSECXPathNodeList::clear </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Clear out the entire list, deleting all entries.
<p>
</td>
</tr>
</table>
<a class="anchor" name="z231_1" doxytag="XSECXPathNodeList::getFirstNode"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode* XSECXPathNodeList::getFirstNode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the first node in the list.
<p>
Returns the first node in the list of nodes and resets the search list.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The first node in the list or NULL if none exist </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z231_2" doxytag="XSECXPathNodeList::getNextNode"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode* XSECXPathNodeList::getNextNode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the next node in the list.
<p>
Returns the next node in the list.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The next node in the list of NULL if none exist </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z231_0" doxytag="XSECXPathNodeList::hasNode"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool XSECXPathNodeList::hasNode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname1" valign="top" nowrap> <em>n</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Check if a node exists in the list.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>The node to find in the list. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z232_0" doxytag="XSECXPathNodeList::intersect"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void XSECXPathNodeList::intersect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECXPathNodeList.html">XSECXPathNodeList</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>toIntersect</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Intersect with nodeset.
<p>
Delete any nodes in my list that are not in the intersect list<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>toIntersect</em> </td><td>The list to intersect with. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z229_3" doxytag="XSECXPathNodeList::operator="></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classXSECXPathNodeList.html">XSECXPathNodeList</a>& XSECXPathNodeList::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECXPathNodeList.html">XSECXPathNodeList</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>toCopy</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Assignment Operator.
<p>
Set one node list equal to another.<p>
<dl compact><dt><b>Note:</b></dt><dd>Do not do this frequently, particularly for large lists as it will replicate the entire list and is a fairly expensive operation</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>toCopy</em> </td><td>The list to be copied from </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z230_1" doxytag="XSECXPathNodeList::removeNode"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void XSECXPathNodeList::removeNode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname1" valign="top" nowrap> <em>n</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Remove a node from the list.
<p>
Given a node, find it in the list and (if it exists) delete it from the list.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>The node to be removed. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECXPathNodeList_8hpp-source.html">XSECXPathNodeList.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:46:09 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
