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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Thu Mar 15 14:18:28 EST 2001 -->
<TITLE>
Xalan-Java 2: Class NodeSet
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/NodeSet.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/xpath/Expression.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/xpath/SourceTree.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="NodeSet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.xpath</FONT>
<BR>
Class NodeSet</H2>
<PRE>
java.lang.Object
|
+--<A HREF="../../../org/apache/xml/utils/NodeVector.html">org.apache.xml.utils.NodeVector</A>
|
+--<B>org.apache.xpath.NodeSet</B>
</PRE>
<HR>
<DL>
<DT>public class <B>NodeSet</B><DT>extends <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A><DT>implements <A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A>, <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A>, java.lang.Cloneable, <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A></DL>
<P>
<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
<p>The NodeSet class can act as either a NodeVector,
NodeList, or NodeIterator. However, in order for it to
act as a NodeVector or NodeList, it's required that
setShouldCacheNodes(true) be called before the first
nextNode() is called, in order that nodes can be added
as they are fetched. Derived classes that implement iterators
must override runTo(int index), in order that they may
run the iteration to the given index. </p>
<p>Note that we directly implement the DOM's NodeIterator
interface. We do not emulate all the behavior of the
standard NodeIterator. In particular, we do not guarantee
to present a "live view" of the document ... but in XSLT,
the source document should never be mutated, so this should
never be an issue.</p>
<p>Thought: Should NodeSet really implement NodeList and NodeIterator,
or should there be specific subclasses of it which do so? The
advantage of doing it all here is that all NodeSets will respond
to the same calls; the disadvantage is that some of them may return
less-than-enlightening results when you do so.</p>
<P>
<DL>
<DT><B>See Also: </B><DD><A HREF="../../../serialized-form.html#org.apache.xpath.NodeSet">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#NodeSet()">NodeSet</A></B>()</CODE>
<BR>
Create an empty nodelist.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#NodeSet(int)">NodeSet</A></B>(int blocksize)</CODE>
<BR>
Create an empty, using the given block size.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#NodeSet(org.w3c.dom.Node)">NodeSet</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> node)</CODE>
<BR>
Create a NodeSet which contains the given Node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#NodeSet(org.w3c.dom.traversal.NodeIterator)">NodeSet</A></B>(<A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> ni)</CODE>
<BR>
Create a NodeSet, and copy the members of the
given NodeIterator into it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#NodeSet(org.w3c.dom.NodeList)">NodeSet</A></B>(<A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A> nodelist)</CODE>
<BR>
Create a NodeSet, and copy the members of the
given nodelist into it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#NodeSet(org.apache.xpath.NodeSet)">NodeSet</A></B>(<A HREF="../../../org/apache/xpath/NodeSet.html">NodeSet</A> nodelist)</CODE>
<BR>
Create a NodeSet, and copy the members of the
given NodeSet into it.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addElement(org.w3c.dom.Node)">addElement</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> value)</CODE>
<BR>
Append a Node onto the vector.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addNode(org.w3c.dom.Node)">addNode</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> n)</CODE>
<BR>
Add a node to the NodeSet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addNodeInDocOrder(org.w3c.dom.Node, boolean, org.apache.xpath.XPathContext)">addNodeInDocOrder</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> node,
boolean test,
<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</CODE>
<BR>
Add the node into a vector of nodes where it should occur in
document order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addNodeInDocOrder(org.w3c.dom.Node, org.apache.xpath.XPathContext)">addNodeInDocOrder</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> node,
<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</CODE>
<BR>
Add the node into a vector of nodes where it should occur in
document order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addNodes(org.w3c.dom.traversal.NodeIterator)">addNodes</A></B>(<A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> iterator)</CODE>
<BR>
Copy NodeList members into this nodelist, adding in
document order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addNodes(org.w3c.dom.NodeList)">addNodes</A></B>(<A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A> nodelist)</CODE>
<BR>
Copy NodeList members into this nodelist, adding in
document order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addNodes(org.apache.xpath.NodeSet)">addNodes</A></B>(<A HREF="../../../org/apache/xpath/NodeSet.html">NodeSet</A> ns)</CODE>
<BR>
Copy NodeList members into this nodelist, adding in
document order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addNodesInDocOrder(org.w3c.dom.traversal.NodeIterator, org.apache.xpath.XPathContext)">addNodesInDocOrder</A></B>(<A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> iterator,
<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</CODE>
<BR>
Copy NodeList members into this nodelist, adding in
document order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#addNodesInDocOrder(org.w3c.dom.NodeList, org.apache.xpath.XPathContext)">addNodesInDocOrder</A></B>(<A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A> nodelist,
<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</CODE>
<BR>
Copy NodeList members into this nodelist, adding in
document order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#appendNodes(org.apache.xml.utils.NodeVector)">appendNodes</A></B>(<A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A> nodes)</CODE>
<BR>
Append the nodes to the list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#clone()">clone</A></B>()</CODE>
<BR>
Clone this NodeSet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#cloneWithReset()">cloneWithReset</A></B>()</CODE>
<BR>
Get a cloned Iterator, and reset its state to the beginning of the
iteration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#contains(org.w3c.dom.Node)">contains</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> s)</CODE>
<BR>
Tell if the table contains the given node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#detach()">detach</A></B>()</CODE>
<BR>
Detaches the iterator from the set which it iterated over, releasing
any computational resources and placing the iterator in the INVALID
state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#elementAt(int)">elementAt</A></B>(int i)</CODE>
<BR>
Get the nth element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getCurrentNode()">getCurrentNode</A></B>()</CODE>
<BR>
Return the last fetched node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getCurrentPos()">getCurrentPos</A></B>()</CODE>
<BR>
Get the current position, which is one less than
the next nextNode() call will retrieve.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getExpandEntityReferences()">getExpandEntityReferences</A></B>()</CODE>
<BR>
The value of this flag determines whether the children of entity
reference nodes are visible to the iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getFilter()">getFilter</A></B>()</CODE>
<BR>
The filter object used to screen nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getLast()">getLast</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getLength()">getLength</A></B>()</CODE>
<BR>
The number of nodes in the list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getRoot()">getRoot</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getShouldCacheNodes()">getShouldCacheNodes</A></B>()</CODE>
<BR>
Get whether or not this is a cached node set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#getWhatToShow()">getWhatToShow</A></B>()</CODE>
<BR>
This attribute determines which node types are presented via the
iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#indexOf(org.w3c.dom.Node)">indexOf</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> elem)</CODE>
<BR>
Searches for the first occurence of the given argument,
beginning the search at index, and testing for equality
using the equals method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#indexOf(org.w3c.dom.Node, int)">indexOf</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> elem,
int index)</CODE>
<BR>
Searches for the first occurence of the given argument,
beginning the search at index, and testing for equality
using the equals method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#insertElementAt(org.w3c.dom.Node, int)">insertElementAt</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> value,
int at)</CODE>
<BR>
Inserts the specified node in this vector at the specified index.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#insertNode(org.w3c.dom.Node, int)">insertNode</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> n,
int pos)</CODE>
<BR>
Insert a node at a given position.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#isFresh()">isFresh</A></B>()</CODE>
<BR>
Tells if this NodeSet is "fresh", in other words, if
the first nextNode() that is called will return the
first node in the set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#item(int)">item</A></B>(int index)</CODE>
<BR>
Returns the <code>index</code>th item in the collection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#nextNode()">nextNode</A></B>()</CODE>
<BR>
Returns the next node in the set and advances the position of the
iterator in the set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#previousNode()">previousNode</A></B>()</CODE>
<BR>
Returns the previous node in the set and moves the position of the
iterator backwards in the set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#removeAllElements()">removeAllElements</A></B>()</CODE>
<BR>
Inserts the specified node in this vector at the specified index.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#removeElement(org.w3c.dom.Node)">removeElement</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> s)</CODE>
<BR>
Removes the first occurrence of the argument from this vector.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#removeElementAt(int)">removeElementAt</A></B>(int i)</CODE>
<BR>
Deletes the component at the specified index.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#removeNode(org.w3c.dom.Node)">removeNode</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> n)</CODE>
<BR>
Remove a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#reset()">reset</A></B>()</CODE>
<BR>
Reset the iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#runTo(int)">runTo</A></B>(int index)</CODE>
<BR>
If an index is requested, NodeSet will call this method
to run the iterator to the index.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#setCurrentPos(int)">setCurrentPos</A></B>(int i)</CODE>
<BR>
Set the current position in the node set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#setElementAt(org.w3c.dom.Node, int)">setElementAt</A></B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> node,
int index)</CODE>
<BR>
Sets the component at the specified index of this vector to be the
specified object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#setLast(int)">setLast</A></B>(int last)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A></B>(boolean b)</CODE>
<BR>
If setShouldCacheNodes(true) is called, then nodes will
be cached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSet.html#size()">size</A></B>()</CODE>
<BR>
Get the length of the list.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.xml.utils.NodeVector"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.xml.utils.<A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../org/apache/xml/utils/NodeVector.html#peepOrNull()">peepOrNull</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#peepTail()">peepTail</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#peepTailSub1()">peepTailSub1</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#pop()">pop</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#popAndTop()">popAndTop</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#popPair()">popPair</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#popQuick()">popQuick</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#push(org.w3c.dom.Node)">push</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#pushPair(org.w3c.dom.Node, org.w3c.dom.Node)">pushPair</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#setTail(org.w3c.dom.Node)">setTail</A>,
<A HREF="../../../org/apache/xml/utils/NodeVector.html#setTailSub1(org.w3c.dom.Node)">setTailSub1</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="NodeSet()"><!-- --></A><H3>
NodeSet</H3>
<PRE>
public <B>NodeSet</B>()</PRE>
<DL>
<DD>Create an empty nodelist.</DL>
<HR>
<A NAME="NodeSet(int)"><!-- --></A><H3>
NodeSet</H3>
<PRE>
public <B>NodeSet</B>(int blocksize)</PRE>
<DL>
<DD>Create an empty, using the given block size.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>blocksize</CODE> - Size of blocks to allocate</DL>
</DD>
</DL>
<HR>
<A NAME="NodeSet(org.w3c.dom.NodeList)"><!-- --></A><H3>
NodeSet</H3>
<PRE>
public <B>NodeSet</B>(<A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A> nodelist)</PRE>
<DL>
<DD>Create a NodeSet, and copy the members of the
given nodelist into it.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodelist</CODE> - List of Nodes to be made members of the new set.</DL>
</DD>
</DL>
<HR>
<A NAME="NodeSet(org.apache.xpath.NodeSet)"><!-- --></A><H3>
NodeSet</H3>
<PRE>
public <B>NodeSet</B>(<A HREF="../../../org/apache/xpath/NodeSet.html">NodeSet</A> nodelist)</PRE>
<DL>
<DD>Create a NodeSet, and copy the members of the
given NodeSet into it.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodelist</CODE> - Set of Nodes to be made members of the new set.</DL>
</DD>
</DL>
<HR>
<A NAME="NodeSet(org.w3c.dom.traversal.NodeIterator)"><!-- --></A><H3>
NodeSet</H3>
<PRE>
public <B>NodeSet</B>(<A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> ni)</PRE>
<DL>
<DD>Create a NodeSet, and copy the members of the
given NodeIterator into it.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ni</CODE> - Iterator which yields Nodes to be made members of the new set.</DL>
</DD>
</DL>
<HR>
<A NAME="NodeSet(org.w3c.dom.Node)"><!-- --></A><H3>
NodeSet</H3>
<PRE>
public <B>NodeSet</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> node)</PRE>
<DL>
<DD>Create a NodeSet which contains the given Node.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - Single node to be added to the new set.</DL>
</DD>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getRoot()"><!-- --></A><H3>
getRoot</H3>
<PRE>
public <A HREF="../../../org/w3c/dom/Node.html">Node</A> <B>getRoot</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/traversal/NodeIterator.html#getRoot()">getRoot</A> in interface <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A><DT><B>Returns:</B><DD>The root node of the Iterator, as specified when it was created.
For non-Iterator NodeSets, this will be null.</DL>
</DD>
</DL>
<HR>
<A NAME="clone()"><!-- --></A><H3>
clone</H3>
<PRE>
public java.lang.Object <B>clone</B>()
throws java.lang.CloneNotSupportedException</PRE>
<DL>
<DD>Clone this NodeSet.
At this time, we only expect this to be used with LocPathIterators;
it may not work with other kinds of NodeSets.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#clone()">clone</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Returns:</B><DD>a new NodeSet of the same type, having the same state...
though unless overridden in the subclasses, it may not copy all
the state information.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - if this subclass of NodeSet
does not support the clone() operation.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#clone()">clone</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="cloneWithReset()"><!-- --></A><H3>
cloneWithReset</H3>
<PRE>
public <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> <B>cloneWithReset</B>()
throws java.lang.CloneNotSupportedException</PRE>
<DL>
<DD>Get a cloned Iterator, and reset its state to the beginning of the
iteration.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#cloneWithReset()">cloneWithReset</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Returns:</B><DD>a new NodeSet of the same type, having the same state...
except that the reset() operation has been called.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - if this subclass of NodeSet
does not support the clone() operation.</DL>
</DD>
</DL>
<HR>
<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public void <B>reset</B>()</PRE>
<DL>
<DD>Reset the iterator. May have no effect on non-iterator Nodesets.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#reset()">reset</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A></DL>
</DD>
</DL>
<HR>
<A NAME="getWhatToShow()"><!-- --></A><H3>
getWhatToShow</H3>
<PRE>
public int <B>getWhatToShow</B>()</PRE>
<DL>
<DD>This attribute determines which node types are presented via the
iterator. The available set of constants is defined in the
<code>NodeFilter</code> interface. For NodeSets, the mask has been
hardcoded to show all nodes except EntityReference nodes, which have
no equivalent in the XPath data model.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/traversal/NodeIterator.html#getWhatToShow()">getWhatToShow</A> in interface <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A><DT><B>Returns:</B><DD>integer used as a bit-array, containing flags defined in
the DOM's NodeFilter class. The value will be
<code>SHOW_ALL & ~SHOW_ENTITY_REFERENCE</code>, meaning that
only entity references are suppressed.</DL>
</DD>
</DL>
<HR>
<A NAME="getFilter()"><!-- --></A><H3>
getFilter</H3>
<PRE>
public <A HREF="../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A> <B>getFilter</B>()</PRE>
<DL>
<DD>The filter object used to screen nodes. Filters are applied to
further reduce (and restructure) the NodeIterator's view of the
document. In our case, we will be using hardcoded filters built
into our iterators... but getFilter() is part of the DOM's
NodeIterator interface, so we have to support it.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/traversal/NodeIterator.html#getFilter()">getFilter</A> in interface <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A><DT><B>Returns:</B><DD>null, which is slightly misleading. True, there is no
user-written filter object, but in fact we are doing some very
sophisticated custom filtering. A DOM purist might suggest
returning a placeholder object just to indicate that this is
not going to return all nodes selected by whatToShow.</DL>
</DD>
</DL>
<HR>
<A NAME="getExpandEntityReferences()"><!-- --></A><H3>
getExpandEntityReferences</H3>
<PRE>
public boolean <B>getExpandEntityReferences</B>()</PRE>
<DL>
<DD>The value of this flag determines whether the children of entity
reference nodes are visible to the iterator. If false, they will be
skipped over.
<br> To produce a view of the document that has entity references
expanded and does not expose the entity reference node itself, use the
whatToShow flags to hide the entity reference node and set
expandEntityReferences to true when creating the iterator. To produce
a view of the document that has entity reference nodes but no entity
expansion, use the whatToShow flags to show the entity reference node
and set expandEntityReferences to false.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/traversal/NodeIterator.html#getExpandEntityReferences()">getExpandEntityReferences</A> in interface <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A><DT><B>Returns:</B><DD>true for all iterators based on NodeSet, meaning that the
contents of EntityRefrence nodes may be returned (though whatToShow
says that the EntityReferences themselves are not shown.)</DL>
</DD>
</DL>
<HR>
<A NAME="nextNode()"><!-- --></A><H3>
nextNode</H3>
<PRE>
public <A HREF="../../../org/w3c/dom/Node.html">Node</A> <B>nextNode</B>()
throws <A HREF="../../../org/w3c/dom/DOMException.html">DOMException</A></PRE>
<DL>
<DD>Returns the next node in the set and advances the position of the
iterator in the set. After a NodeIterator is created, the first call
to nextNode() returns the first node in the set.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/traversal/NodeIterator.html#nextNode()">nextNode</A> in interface <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A><DT><B>Returns:</B><DD>The next <code>Node</code> in the set being iterated over, or
<code>null</code> if there are no more members in that set.<DT><B>Throws:</B><DD><A HREF="../../../org/w3c/dom/DOMException.html">DOMException</A> - INVALID_STATE_ERR: Raised if this method is called after the
<code>detach</code> method was invoked.</DL>
</DD>
</DL>
<HR>
<A NAME="previousNode()"><!-- --></A><H3>
previousNode</H3>
<PRE>
public <A HREF="../../../org/w3c/dom/Node.html">Node</A> <B>previousNode</B>()
throws <A HREF="../../../org/w3c/dom/DOMException.html">DOMException</A></PRE>
<DL>
<DD>Returns the previous node in the set and moves the position of the
iterator backwards in the set.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/traversal/NodeIterator.html#previousNode()">previousNode</A> in interface <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A><DT><B>Returns:</B><DD>The previous <code>Node</code> in the set being iterated over,
or<code>null</code> if there are no more members in that set.<DT><B>Throws:</B><DD><A HREF="../../../org/w3c/dom/DOMException.html">DOMException</A> - INVALID_STATE_ERR: Raised if this method is called after the
<code>detach</code> method was invoked.<DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a cached type, and hence doesn't know what the previous node was.</DL>
</DD>
</DL>
<HR>
<A NAME="detach()"><!-- --></A><H3>
detach</H3>
<PRE>
public void <B>detach</B>()</PRE>
<DL>
<DD>Detaches the iterator from the set which it iterated over, releasing
any computational resources and placing the iterator in the INVALID
state. After<code>detach</code> has been invoked, calls to
<code>nextNode</code> or<code>previousNode</code> will raise the
exception INVALID_STATE_ERR.
<p>
This operation is a no-op in NodeSet, and will not cause
INVALID_STATE_ERR to be raised by later operations.
</p><DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/traversal/NodeIterator.html#detach()">detach</A> in interface <A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A></DL>
</DD>
</DL>
<HR>
<A NAME="isFresh()"><!-- --></A><H3>
isFresh</H3>
<PRE>
public boolean <B>isFresh</B>()</PRE>
<DL>
<DD>Tells if this NodeSet is "fresh", in other words, if
the first nextNode() that is called will return the
first node in the set.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#isFresh()">isFresh</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Returns:</B><DD>true if nextNode() would return the first node in the set,
false if it would return a later one.</DL>
</DD>
</DL>
<HR>
<A NAME="runTo(int)"><!-- --></A><H3>
runTo</H3>
<PRE>
public void <B>runTo</B>(int index)</PRE>
<DL>
<DD>If an index is requested, NodeSet will call this method
to run the iterator to the index. By default this sets
m_next to the index. If the index argument is -1, this
signals that the iterator should be run to the end.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#runTo(int)">runTo</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Parameters:</B><DD><CODE>index</CODE> - Position to advance (or retreat) to, with
0 requesting the reset ("fresh") position and -1 (or indeed
any out-of-bounds value) requesting the final position.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not
one of the types which supports indexing/counting.</DL>
</DD>
</DL>
<HR>
<A NAME="item(int)"><!-- --></A><H3>
item</H3>
<PRE>
public <A HREF="../../../org/w3c/dom/Node.html">Node</A> <B>item</B>(int index)</PRE>
<DL>
<DD>Returns the <code>index</code>th item in the collection. If
<code>index</code> is greater than or equal to the number of nodes in
the list, this returns <code>null</code>.
TODO: What happens if index is out of range?<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/NodeList.html#item(int)">item</A> in interface <A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A><DT><B>Parameters:</B><DD><CODE>index</CODE> - Index into the collection.<DT><B>Returns:</B><DD>The node at the <code>index</code>th position in the
<code>NodeList</code>, or <code>null</code> if that is not a valid
index.</DL>
</DD>
</DL>
<HR>
<A NAME="getLength()"><!-- --></A><H3>
getLength</H3>
<PRE>
public int <B>getLength</B>()</PRE>
<DL>
<DD>The number of nodes in the list. The range of valid child node indices is
0 to <code>length-1</code> inclusive. Note that this operation requires
finding all the matching nodes, which may defeat attempts to defer
that work.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/w3c/dom/NodeList.html#getLength()">getLength</A> in interface <A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A><DT><B>Returns:</B><DD>integer indicating how many nodes are represented by this list.</DL>
</DD>
</DL>
<HR>
<A NAME="addNode(org.w3c.dom.Node)"><!-- --></A><H3>
addNode</H3>
<PRE>
public void <B>addNode</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> n)</PRE>
<DL>
<DD>Add a node to the NodeSet. Not all types of NodeSets support this
operation<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be added<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="insertNode(org.w3c.dom.Node, int)"><!-- --></A><H3>
insertNode</H3>
<PRE>
public void <B>insertNode</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> n,
int pos)</PRE>
<DL>
<DD>Insert a node at a given position.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be added<DD><CODE>pos</CODE> - Offset at which the node is to be inserted,
with 0 being the first position.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="removeNode(org.w3c.dom.Node)"><!-- --></A><H3>
removeNode</H3>
<PRE>
public void <B>removeNode</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> n)</PRE>
<DL>
<DD>Remove a node.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be added<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="addNodes(org.w3c.dom.NodeList)"><!-- --></A><H3>
addNodes</H3>
<PRE>
public void <B>addNodes</B>(<A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A> nodelist)</PRE>
<DL>
<DD>Copy NodeList members into this nodelist, adding in
document order. If a node is null, don't add it.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodelist</CODE> - List of nodes which should now be referenced by
this NodeSet.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="addNodes(org.apache.xpath.NodeSet)"><!-- --></A><H3>
addNodes</H3>
<PRE>
public void <B>addNodes</B>(<A HREF="../../../org/apache/xpath/NodeSet.html">NodeSet</A> ns)</PRE>
<DL>
<DD><p>Copy NodeList members into this nodelist, adding in
document order. Only genuine node references will be copied;
nulls appearing in the source NodeSet will
not be added to this one. </p>
<p> In case you're wondering why this function is needed: NodeSet
implements both NodeIterator and NodeList. If this method isn't
provided, Java can't decide which of those to use when addNodes()
is invoked. Providing the more-explicit match avoids that
ambiguity.)</p><DD><DL>
<DT><B>Parameters:</B><DD><CODE>ns</CODE> - NodeSet whose members should be merged into this NodeSet.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="addNodes(org.w3c.dom.traversal.NodeIterator)"><!-- --></A><H3>
addNodes</H3>
<PRE>
public void <B>addNodes</B>(<A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> iterator)</PRE>
<DL>
<DD>Copy NodeList members into this nodelist, adding in
document order. Null references are not added.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>iterator</CODE> - NodeIterator which yields the nodes to be added.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="addNodesInDocOrder(org.w3c.dom.NodeList, org.apache.xpath.XPathContext)"><!-- --></A><H3>
addNodesInDocOrder</H3>
<PRE>
public void <B>addNodesInDocOrder</B>(<A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A> nodelist,
<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</PRE>
<DL>
<DD>Copy NodeList members into this nodelist, adding in
document order. If a node is null, don't add it.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodelist</CODE> - List of nodes to be added<DD><CODE>support</CODE> - The XPath runtime context.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="addNodesInDocOrder(org.w3c.dom.traversal.NodeIterator, org.apache.xpath.XPathContext)"><!-- --></A><H3>
addNodesInDocOrder</H3>
<PRE>
public void <B>addNodesInDocOrder</B>(<A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> iterator,
<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</PRE>
<DL>
<DD>Copy NodeList members into this nodelist, adding in
document order. If a node is null, don't add it.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>iterator</CODE> - NodeIterator which yields the nodes to be added.<DD><CODE>support</CODE> - The XPath runtime context.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="addNodeInDocOrder(org.w3c.dom.Node, boolean, org.apache.xpath.XPathContext)"><!-- --></A><H3>
addNodeInDocOrder</H3>
<PRE>
public int <B>addNodeInDocOrder</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> node,
boolean test,
<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</PRE>
<DL>
<DD>Add the node into a vector of nodes where it should occur in
document order.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Vector of nodes, presumably containing Nodes<DD><CODE>obj</CODE> - Node object.<DD><CODE>node</CODE> - The node to be added.<DD><CODE>test</CODE> - true if we should test for doc order<DD><CODE>support</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>insertIndex.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="addNodeInDocOrder(org.w3c.dom.Node, org.apache.xpath.XPathContext)"><!-- --></A><H3>
addNodeInDocOrder</H3>
<PRE>
public int <B>addNodeInDocOrder</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> node,
<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</PRE>
<DL>
<DD>Add the node into a vector of nodes where it should occur in
document order.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Vector of nodes, presumably containing Nodes<DD><CODE>obj</CODE> - Node object.<DD><CODE>node</CODE> - The node to be added.<DD><CODE>support</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>The index where it was inserted.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.</DL>
</DD>
</DL>
<HR>
<A NAME="size()"><!-- --></A><H3>
size</H3>
<PRE>
public int <B>size</B>()</PRE>
<DL>
<DD>Get the length of the list.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#size()">size</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Returns:</B><DD>The size of this node set.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#size()">size</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="addElement(org.w3c.dom.Node)"><!-- --></A><H3>
addElement</H3>
<PRE>
public void <B>addElement</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> value)</PRE>
<DL>
<DD>Append a Node onto the vector.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - The node to be added.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#addElement(org.w3c.dom.Node)">addElement</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="insertElementAt(org.w3c.dom.Node, int)"><!-- --></A><H3>
insertElementAt</H3>
<PRE>
public void <B>insertElementAt</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> value,
int at)</PRE>
<DL>
<DD>Inserts the specified node in this vector at the specified index.
Each component in this vector with an index greater or equal to
the specified index is shifted upward to have an index one greater
than the value it had previously.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - The node to be inserted.<DD><CODE>at</CODE> - The index where the insert should occur.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#insertElementAt(org.w3c.dom.Node, int)">insertElementAt</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="appendNodes(org.apache.xml.utils.NodeVector)"><!-- --></A><H3>
appendNodes</H3>
<PRE>
public void <B>appendNodes</B>(<A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A> nodes)</PRE>
<DL>
<DD>Append the nodes to the list.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodes</CODE> - The nodes to be appended to this node set.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#appendNodes(org.apache.xml.utils.NodeVector)">appendNodes</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="removeAllElements()"><!-- --></A><H3>
removeAllElements</H3>
<PRE>
public void <B>removeAllElements</B>()</PRE>
<DL>
<DD>Inserts the specified node in this vector at the specified index.
Each component in this vector with an index greater or equal to
the specified index is shifted upward to have an index one greater
than the value it had previously.<DD><DL>
<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#removeAllElements()">removeAllElements</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="removeElement(org.w3c.dom.Node)"><!-- --></A><H3>
removeElement</H3>
<PRE>
public boolean <B>removeElement</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> s)</PRE>
<DL>
<DD>Removes the first occurrence of the argument from this vector.
If the object is found in this vector, each component in the vector
with an index greater or equal to the object's index is shifted
downward to have an index one smaller than the value it had
previously.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - The node to be removed.<DT><B>Returns:</B><DD>True if the node was successfully removed<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#removeElement(org.w3c.dom.Node)">removeElement</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="removeElementAt(int)"><!-- --></A><H3>
removeElementAt</H3>
<PRE>
public void <B>removeElementAt</B>(int i)</PRE>
<DL>
<DD>Deletes the component at the specified index. Each component in
this vector with an index greater or equal to the specified
index is shifted downward to have an index one smaller than
the value it had previously.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>i</CODE> - The index of the node to be removed.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#removeElementAt(int)">removeElementAt</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="setElementAt(org.w3c.dom.Node, int)"><!-- --></A><H3>
setElementAt</H3>
<PRE>
public void <B>setElementAt</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> node,
int index)</PRE>
<DL>
<DD>Sets the component at the specified index of this vector to be the
specified object. The previous component at that position is discarded.
The index must be a value greater than or equal to 0 and less
than the current size of the vector.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - The node to be set.<DD><CODE>index</CODE> - The index of the node to be replaced.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#setElementAt(org.w3c.dom.Node, int)">setElementAt</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="elementAt(int)"><!-- --></A><H3>
elementAt</H3>
<PRE>
public <A HREF="../../../org/w3c/dom/Node.html">Node</A> <B>elementAt</B>(int i)</PRE>
<DL>
<DD>Get the nth element.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>i</CODE> - The index of the requested node.<DT><B>Returns:</B><DD>Node at specified index.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#elementAt(int)">elementAt</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="contains(org.w3c.dom.Node)"><!-- --></A><H3>
contains</H3>
<PRE>
public boolean <B>contains</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> s)</PRE>
<DL>
<DD>Tell if the table contains the given node.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - Node to look for<DT><B>Returns:</B><DD>True if the given node was found.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#contains(org.w3c.dom.Node)">contains</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="indexOf(org.w3c.dom.Node, int)"><!-- --></A><H3>
indexOf</H3>
<PRE>
public int <B>indexOf</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> elem,
int index)</PRE>
<DL>
<DD>Searches for the first occurence of the given argument,
beginning the search at index, and testing for equality
using the equals method.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>elem</CODE> - Node to look for<DD><CODE>index</CODE> - Index of where to start the search<DT><B>Returns:</B><DD>the index of the first occurrence of the object
argument in this vector at position index or later in the
vector; returns -1 if the object is not found.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#indexOf(org.w3c.dom.Node, int)">indexOf</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="indexOf(org.w3c.dom.Node)"><!-- --></A><H3>
indexOf</H3>
<PRE>
public int <B>indexOf</B>(<A HREF="../../../org/w3c/dom/Node.html">Node</A> elem)</PRE>
<DL>
<DD>Searches for the first occurence of the given argument,
beginning the search at index, and testing for equality
using the equals method.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>elem</CODE> - Node to look for<DT><B>Returns:</B><DD>the index of the first occurrence of the object
argument in this vector at position index or later in the
vector; returns -1 if the object is not found.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#indexOf(org.w3c.dom.Node)">indexOf</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
</DD>
</DL>
<HR>
<A NAME="getCurrentPos()"><!-- --></A><H3>
getCurrentPos</H3>
<PRE>
public int <B>getCurrentPos</B>()</PRE>
<DL>
<DD>Get the current position, which is one less than
the next nextNode() call will retrieve. i.e. if
you call getCurrentPos() and the return is 0, the next
fetch will take place at index 1.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#getCurrentPos()">getCurrentPos</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Returns:</B><DD>The the current position index.</DL>
</DD>
</DL>
<HR>
<A NAME="setCurrentPos(int)"><!-- --></A><H3>
setCurrentPos</H3>
<PRE>
public void <B>setCurrentPos</B>(int i)</PRE>
<DL>
<DD>Set the current position in the node set.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#setCurrentPos(int)">setCurrentPos</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Parameters:</B><DD><CODE>i</CODE> - Must be a valid index.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a cached type, and thus doesn't permit indexed access.</DL>
</DD>
</DL>
<HR>
<A NAME="getCurrentNode()"><!-- --></A><H3>
getCurrentNode</H3>
<PRE>
public <A HREF="../../../org/w3c/dom/Node.html">Node</A> <B>getCurrentNode</B>()</PRE>
<DL>
<DD>Return the last fetched node. Needed to support the UnionPathIterator.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#getCurrentNode()">getCurrentNode</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Returns:</B><DD>the last fetched node.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSet is not of
a cached type, and thus doesn't permit indexed access.</DL>
</DD>
</DL>
<HR>
<A NAME="getShouldCacheNodes()"><!-- --></A><H3>
getShouldCacheNodes</H3>
<PRE>
public boolean <B>getShouldCacheNodes</B>()</PRE>
<DL>
<DD>Get whether or not this is a cached node set.<DD><DL>
<DT><B>Returns:</B><DD>True if this list is cached.</DL>
</DD>
</DL>
<HR>
<A NAME="setShouldCacheNodes(boolean)"><!-- --></A><H3>
setShouldCacheNodes</H3>
<PRE>
public void <B>setShouldCacheNodes</B>(boolean b)</PRE>
<DL>
<DD>If setShouldCacheNodes(true) is called, then nodes will
be cached. They are not cached by default. This switch must
be set before the first call to nextNode is made, to ensure
that all nodes are cached.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A><DT><B>Parameters:</B><DD><CODE>b</CODE> - true if this node set should be cached.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if an attempt is made to
request caching after we've already begun stepping through the
nodes in this set.</DL>
</DD>
</DL>
<HR>
<A NAME="getLast()"><!-- --></A><H3>
getLast</H3>
<PRE>
public int <B>getLast</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#getLast()">getLast</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A></DL>
</DD>
</DL>
<HR>
<A NAME="setLast(int)"><!-- --></A><H3>
setLast</H3>
<PRE>
public void <B>setLast</B>(int last)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/axes/ContextNodeList.html#setLast(int)">setLast</A> in interface <A HREF="../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/NodeSet.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/xpath/Expression.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/xpath/SourceTree.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="NodeSet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright 2000 Apache XML Project. All Rights Reserved.
</BODY>
</HTML>
|
