File: LocPathIterator.html

package info (click to toggle)
libxalan2-java 2.0.1-1
  • links: PTS
  • area: contrib
  • in suites: woody
  • size: 33,596 kB
  • ctags: 21,079
  • sloc: java: 56,919; xml: 5,150; makefile: 59; sh: 27
file content (1251 lines) | stat: -rw-r--r-- 63,973 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Thu Mar 15 14:18:34 EST 2001 -->
<TITLE>
Xalan-Java 2: Class  LocPathIterator
</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LocPathIterator.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xpath/axes/FollowingWalker.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xpath/axes/NamespaceWalker.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>  &nbsp;
&nbsp;<A HREF="LocPathIterator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.axes</FONT>
<BR>
Class  LocPathIterator</H2>
<PRE>
java.lang.Object
  |
  +--<A HREF="../../../../org/apache/xpath/Expression.html">org.apache.xpath.Expression</A>
        |
        +--<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">org.apache.xpath.patterns.NodeTest</A>
              |
              +--<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">org.apache.xpath.axes.PredicatedNodeTest</A>
                    |
                    +--<B>org.apache.xpath.axes.LocPathIterator</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/xpath/axes/AttributeIterator.html">AttributeIterator</A>, <A HREF="../../../../org/apache/xpath/axes/ChildIterator.html">ChildIterator</A>, <A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html">ChildTestIterator</A>, <A HREF="../../../../org/apache/xpath/axes/DescendantIterator.html">DescendantIterator</A>, <A HREF="../../../../org/apache/xalan/transformer/KeyIterator.html">KeyIterator</A>, <A HREF="../../../../org/apache/xalan/transformer/KeyRefIterator.html">KeyRefIterator</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>LocPathIterator</B><DT>extends <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">PredicatedNodeTest</A><DT>implements java.lang.Cloneable, <A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A>, <A HREF="../../../../org/apache/xpath/axes/ContextNodeList.html">ContextNodeList</A>, <A HREF="../../../../org/w3c/dom/NodeList.html">NodeList</A>, java.io.Serializable</DL>

<P>
<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 This class extends NodeSet, which implements NodeIterator,
 and fetches nodes one at a time in document order based on a XPath
 <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a>.

 <p>If setShouldCacheNodes(true) is called,
 as each node is iterated via nextNode(), the node is also stored
 in the NodeVector, so that previousNode() can easily be done, except in
 the case where the LocPathIterator is "owned" by a UnionPathIterator,
 in which case the UnionPathIterator will cache the nodes.</p>
<P>
<DL>
<DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.xpath.axes.LocPathIterator">Serialized Form</A></DL>
<HR>

<P>
<!-- ======== INNER CLASS SUMMARY ======== -->


<!-- =========== FIELD SUMMARY =========== -->

<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_lastFetched">m_lastFetched</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The last node that was fetched, usually by nextNode.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xpath.patterns.NodeTest"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Fields inherited from class org.apache.xpath.patterns.<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NODETEST">SCORE_NODETEST</A>,  
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NONE">SCORE_NONE</A>,  
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NSWILD">SCORE_NSWILD</A>,  
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_OTHER">SCORE_OTHER</A>,  
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_QNAME">SCORE_QNAME</A>,  
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SHOW_BYFUNCTION">SHOW_BYFUNCTION</A>,  
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SHOW_NAMESPACE">SHOW_NAMESPACE</A>,  
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SUPPORTS_PRE_STRIPPING">SUPPORTS_PRE_STRIPPING</A>,  
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#WILD">WILD</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== 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/axes/LocPathIterator.html#LocPathIterator(org.apache.xpath.compiler.Compiler, int, int)">LocPathIterator</A></B>(<A HREF="../../../../org/apache/xpath/compiler/Compiler.html">Compiler</A>&nbsp;compiler,
                int&nbsp;opPos,
                int&nbsp;analysis)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a LocPathIterator object, including creation
 of step walkers from the opcode list, and call back
 into the Compiler to create predicate expressions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#LocPathIterator(org.apache.xpath.compiler.Compiler, int, int, boolean)">LocPathIterator</A></B>(<A HREF="../../../../org/apache/xpath/compiler/Compiler.html">Compiler</A>&nbsp;compiler,
                int&nbsp;opPos,
                int&nbsp;analysis,
                boolean&nbsp;shouldLoadWalkers)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a LocPathIterator object, including creation
 of step walkers from the opcode list, and call back
 into the Compiler to create predicate expressions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#LocPathIterator(org.apache.xml.utils.PrefixResolver)">LocPathIterator</A></B>(<A HREF="../../../../org/apache/xml/utils/PrefixResolver.html">PrefixResolver</A>&nbsp;nscontext)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a LocPathIterator object.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#addToWaitList(org.apache.xpath.axes.AxesWalker)">addToWaitList</A></B>(<A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A>&nbsp;walker)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Add a walker to the waiting list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#canTraverseOutsideSubtree()">canTraverseOutsideSubtree</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell if this expression or it's subexpressions can traverse outside 
 the current subtree.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#clone()">clone</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a cloned LocPathIterator that holds the same
 position as this iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#cloneWithReset()">cloneWithReset</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a cloned Iterator that is reset to the beginning
 of the query.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#detach()">detach</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../org/apache/xpath/objects/XObject.html">XObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#execute(org.apache.xpath.XPathContext)">execute</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A>&nbsp;xctxt)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute this iterator, meaning create a clone that can
 store state, and initialize it for fast execution from
 the current runtime state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/NodeSet.html">NodeSet</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getCachedNodes()">getCachedNodes</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get cached nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getContext()">getContext</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The node context for the iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getCurrentContextNode()">getCurrentContextNode</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The node context from where the expression is being
 executed from (i.e.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getCurrentNode()">getCurrentNode</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the last fetched node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getCurrentPos()">getCurrentPos</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../org/apache/xpath/DOMHelper.html">DOMHelper</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getDOMHelper()">getDOMHelper</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The DOM helper for the given context;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getExpandEntityReferences()">getExpandEntityReferences</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getFilter()">getFilter</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The filter used to screen nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getFirstWalker()">getFirstWalker</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Get the head of the walker list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getFoundLast()">getFoundLast</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tells if we've found the last node yet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getIsTopLevel()">getIsTopLevel</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Get if this is an iterator at the upper level of
 the XPath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getLast()">getLast</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the index of the last node in the iteration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getLastPos(org.apache.xpath.XPathContext)">getLastPos</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A>&nbsp;xctxt)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the index of the last node that can be itterated to.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getLastUsedWalker()">getLastUsedWalker</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Get the last used walker.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getLength()">getLength</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../org/apache/xml/utils/PrefixResolver.html">PrefixResolver</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getPrefixResolver()">getPrefixResolver</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the saved reference to the prefix resolver that
 was in effect when this iterator was created.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getRoot()">getRoot</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The root node of the Iterator, as specified when it was created.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getWhatToShow()">getWhatToShow</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getXPathContext()">getXPathContext</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The XPath execution context we are operating on.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#initContext(org.apache.xpath.XPathContext)">initContext</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A>&nbsp;execContext)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the context values for this expression
 after it is cloned.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#isFresh()">isFresh</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#item(int)">item</A></B>(int&nbsp;index)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#nextNode()">nextNode</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#previousNode()">previousNode</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#removeFromWaitList(org.apache.xpath.axes.AxesWalker)">removeFromWaitList</A></B>(<A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A>&nbsp;walker)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Remove a walker from the waiting list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#reset()">reset</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset the iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#runTo(int)">runTo</A></B>(int&nbsp;index)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setCurrentContextNode(org.w3c.dom.Node)">setCurrentContextNode</A></B>(<A HREF="../../../../org/w3c/dom/Node.html">Node</A>&nbsp;n)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the current context node for this iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setCurrentPos(int)">setCurrentPos</A></B>(int&nbsp;i)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setIsTopLevel(boolean)">setIsTopLevel</A></B>(boolean&nbsp;b)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Set if this is an iterator at the upper level of
 the XPath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setLast(int)">setLast</A></B>(int&nbsp;last)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the index of the last node in the iteration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setLastUsedWalker(org.apache.xpath.axes.AxesWalker)">setLastUsedWalker</A></B>(<A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A>&nbsp;walker)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Set the last used walker.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A></B>(boolean&nbsp;b)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#size()">size</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the length of the cached nodes.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.axes.PredicatedNodeTest"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">PredicatedNodeTest</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#acceptNode(org.w3c.dom.Node)">acceptNode</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getLocPathIterator()">getLocPathIterator</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getPredicateCount()">getPredicateCount</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getPredicateIndex()">getPredicateIndex</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getProximityPosition()">getProximityPosition</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getProximityPosition(org.apache.xpath.XPathContext)">getProximityPosition</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#initProximityPosition(int)">initProximityPosition</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#isReverseAxes()">isReverseAxes</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#resetProximityPositions()">resetProximityPositions</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#setLocPathIterator(org.apache.xpath.axes.LocPathIterator)">setLocPathIterator</A>, 
<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#setPredicateCount(int)">setPredicateCount</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.patterns.NodeTest"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.xpath.patterns.<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#debugWhatToShow(int)">debugWhatToShow</A>, 
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#execute(org.apache.xpath.XPathContext, org.w3c.dom.Node)">execute</A>, 
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getDefaultScore()">getDefaultScore</A>, 
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getLocalName()">getLocalName</A>, 
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getNamespace()">getNamespace</A>, 
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#initNodeTest(int)">initNodeTest</A>, 
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#initNodeTest(int, java.lang.String, java.lang.String)">initNodeTest</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.Expression"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.xpath.<A HREF="../../../../org/apache/xpath/Expression.html">Expression</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/Expression.html#assert(boolean, java.lang.String)">assert</A>, 
<A HREF="../../../../org/apache/xpath/Expression.html#error(org.apache.xpath.XPathContext, int, java.lang.Object[])">error</A>, 
<A HREF="../../../../org/apache/xpath/Expression.html#setSourceLocator(javax.xml.transform.SourceLocator)">setSourceLocator</A>, 
<A HREF="../../../../org/apache/xpath/Expression.html#warn(org.apache.xpath.XPathContext, int, java.lang.Object[])">warn</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="m_lastFetched"><!-- --></A><H3>
m_lastFetched</H3>
<PRE>
public transient <A HREF="../../../../org/w3c/dom/Node.html">Node</A> <B>m_lastFetched</B></PRE>
<DL>
<DD>The last node that was fetched, usually by nextNode.</DL>

<!-- ========= 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="LocPathIterator(org.apache.xml.utils.PrefixResolver)"><!-- --></A><H3>
LocPathIterator</H3>
<PRE>
public <B>LocPathIterator</B>(<A HREF="../../../../org/apache/xml/utils/PrefixResolver.html">PrefixResolver</A>&nbsp;nscontext)</PRE>
<DL>
<DD>Create a LocPathIterator object.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nscontext</CODE> - The namespace context for this iterator,
 should be OK if null.</DL>
</DD>
</DL>
<HR>

<A NAME="LocPathIterator(org.apache.xpath.compiler.Compiler, int, int)"><!-- --></A><H3>
LocPathIterator</H3>
<PRE>
public <B>LocPathIterator</B>(<A HREF="../../../../org/apache/xpath/compiler/Compiler.html">Compiler</A>&nbsp;compiler,
                       int&nbsp;opPos,
                       int&nbsp;analysis)
                throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
<DL>
<DD>Create a LocPathIterator object, including creation
 of step walkers from the opcode list, and call back
 into the Compiler to create predicate expressions.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>compiler</CODE> - The Compiler which is creating
 this expression.<DD><CODE>opPos</CODE> - The position of this iterator in the
 opcode list from the compiler.<DT><B>Throws:</B><DD><A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A> - &nbsp;</DL>
</DD>
</DL>
<HR>

<A NAME="LocPathIterator(org.apache.xpath.compiler.Compiler, int, int, boolean)"><!-- --></A><H3>
LocPathIterator</H3>
<PRE>
public <B>LocPathIterator</B>(<A HREF="../../../../org/apache/xpath/compiler/Compiler.html">Compiler</A>&nbsp;compiler,
                       int&nbsp;opPos,
                       int&nbsp;analysis,
                       boolean&nbsp;shouldLoadWalkers)
                throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
<DL>
<DD>Create a LocPathIterator object, including creation
 of step walkers from the opcode list, and call back
 into the Compiler to create predicate expressions.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>compiler</CODE> - The Compiler which is creating
 this expression.<DD><CODE>opPos</CODE> - The position of this iterator in the
 opcode list from the compiler.<DD><CODE>shouldLoadWalkers</CODE> - True if walkers should be
 loaded, or false if this is a derived iterator and
 it doesn't wish to load child walkers.<DT><B>Throws:</B><DD><A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A> - &nbsp;</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="execute(org.apache.xpath.XPathContext)"><!-- --></A><H3>
execute</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/objects/XObject.html">XObject</A> <B>execute</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A>&nbsp;xctxt)
                throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
<DL>
<DD>Execute this iterator, meaning create a clone that can
 store state, and initialize it for fast execution from
 the current runtime state.  When this is called, no actual
 query from the current context node is performed.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath execution context.<DT><B>Returns:</B><DD>An XNodeSet reference that holds this iterator.<DT><B>Throws:</B><DD><A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A> - &nbsp;<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#execute(org.apache.xpath.XPathContext)">execute</A> in class <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A></DL>
</DD>
</DL>
<HR>

<A NAME="setIsTopLevel(boolean)"><!-- --></A><H3>
setIsTopLevel</H3>
<PRE>
public void <B>setIsTopLevel</B>(boolean&nbsp;b)</PRE>
<DL>
<DD><i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Set if this is an iterator at the upper level of
 the XPath.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if this location path is at the top level of the
          expression.</DL>
</DD>
</DL>
<HR>

<A NAME="getIsTopLevel()"><!-- --></A><H3>
getIsTopLevel</H3>
<PRE>
public boolean <B>getIsTopLevel</B>()</PRE>
<DL>
<DD><i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Get if this is an iterator at the upper level of
 the XPath.<DD><DL>
<DT><B>Returns:</B><DD>true if this location path is at the top level of the
          expression.</DL>
</DD>
</DL>
<HR>

<A NAME="initContext(org.apache.xpath.XPathContext)"><!-- --></A><H3>
initContext</H3>
<PRE>
public void <B>initContext</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A>&nbsp;execContext)</PRE>
<DL>
<DD>Initialize the context values for this expression
 after it is cloned.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>execContext</CODE> - The XPath runtime context for this
 transformation.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentPos()"><!-- --></A><H3>
getCurrentPos</H3>
<PRE>
public final 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>A value greater than or equal to zero that indicates the next
 node position to fetch.</DL>
</DD>
</DL>
<HR>

<A NAME="setShouldCacheNodes(boolean)"><!-- --></A><H3>
setShouldCacheNodes</H3>
<PRE>
public void <B>setShouldCacheNodes</B>(boolean&nbsp;b)</PRE>
<DL>
<DD>If setShouldCacheNodes(true) is called, then nodes will
 be cached.  They are not cached by default.<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 iterator should cache nodes.</DL>
</DD>
</DL>
<HR>

<A NAME="getCachedNodes()"><!-- --></A><H3>
getCachedNodes</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/NodeSet.html">NodeSet</A> <B>getCachedNodes</B>()</PRE>
<DL>
<DD>Get cached nodes.<DD><DL>
<DT><B>Returns:</B><DD>Cached nodes.</DL>
</DD>
</DL>
<HR>

<A NAME="setCurrentPos(int)"><!-- --></A><H3>
setCurrentPos</H3>
<PRE>
public void <B>setCurrentPos</B>(int&nbsp;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 greater
 than or equal to zero and less than m_cachedNodes.size().</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 cached nodes.

 <p>Note: for the moment at least, this only returns
 the size of the nodes that have been fetched to date,
 it doesn't attempt to run to the end to make sure we
 have found everything.  This should be reviewed.</p><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 the current cache list.</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&nbsp;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> .<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.<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>The number of nodes in the list, always greater or equal to zero.</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 of nextNode has not been called.</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.</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.

 <p>This is somewhat useless at this time, since it doesn't
 really return information that tells what this iterator will
 show.  It is here only to fullfill the DOM NodeIterator
 interface.</p><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>For now, always NodeFilter.SHOW_ALL & ~NodeFilter.SHOW_ENTITY_REFERENCE.<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getWhatToShow()">getWhatToShow</A> in class <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A><DT><B>See Also: </B><DD><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html"><CODE>NodeIterator</CODE></A></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 used to screen nodes.  Not used at this time,
 this is here only to fullfill the DOM NodeIterator
 interface.<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>Always null.<DT><B>See Also: </B><DD><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html"><CODE>NodeIterator</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getRoot()"><!-- --></A><H3>
getRoot</H3>
<PRE>
public <A HREF="../../../../org/w3c/dom/Node.html">Node</A> <B>getRoot</B>()</PRE>
<DL>
<DD>The root node of the Iterator, as specified when it was created.<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" of this iterator, which, in XPath terms,
 is the node context for this iterator.</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>Always true, since entity reference nodes are not
 visible in the XPath model.</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.<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="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 that is reset to the beginning
 of the query.<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 cloned NodeIterator set of the start of the query.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - &nbsp;</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>Get a cloned LocPathIterator that holds the same
 position as this iterator.<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 clone of this iterator that holds the same node position.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - &nbsp;<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#clone()">clone</A> in class <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">PredicatedNodeTest</A></DL>
</DD>
</DL>
<HR>

<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public void <B>reset</B>()</PRE>
<DL>
<DD>Reset the iterator.<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="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="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, or null if the last fetch was null.</DL>
</DD>
</DL>
<HR>

<A NAME="runTo(int)"><!-- --></A><H3>
runTo</H3>
<PRE>
public void <B>runTo</B>(int&nbsp;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> - The index to run to, or -1 if the iterator
 should run to the end.</DL>
</DD>
</DL>
<HR>

<A NAME="getFirstWalker()"><!-- --></A><H3>
getFirstWalker</H3>
<PRE>
public final <A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A> <B>getFirstWalker</B>()</PRE>
<DL>
<DD><i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Get the head of the walker list.<DD><DL>
<DT><B>Returns:</B><DD>The head of the walker list, or null
 if this iterator does not implement walkers.</DL>
</DD>
</DL>
<HR>

<A NAME="setLastUsedWalker(org.apache.xpath.axes.AxesWalker)"><!-- --></A><H3>
setLastUsedWalker</H3>
<PRE>
public final void <B>setLastUsedWalker</B>(<A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A>&nbsp;walker)</PRE>
<DL>
<DD><i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Set the last used walker.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>walker</CODE> - The last used walker, or null.</DL>
</DD>
</DL>
<HR>

<A NAME="getLastUsedWalker()"><!-- --></A><H3>
getLastUsedWalker</H3>
<PRE>
public final <A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A> <B>getLastUsedWalker</B>()</PRE>
<DL>
<DD><i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Get the last used walker.<DD><DL>
<DT><B>Returns:</B><DD>The last used walker, or null.</DL>
</DD>
</DL>
<HR>

<A NAME="addToWaitList(org.apache.xpath.axes.AxesWalker)"><!-- --></A><H3>
addToWaitList</H3>
<PRE>
public final void <B>addToWaitList</B>(<A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A>&nbsp;walker)</PRE>
<DL>
<DD><i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Add a walker to the waiting list.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>walker</CODE> - A walker that is waiting for
 other step walkers to complete, before it can
 continue.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xpath/axes/AxesWalker.html"><CODE>AxesWalker</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="removeFromWaitList(org.apache.xpath.axes.AxesWalker)"><!-- --></A><H3>
removeFromWaitList</H3>
<PRE>
public final void <B>removeFromWaitList</B>(<A HREF="../../../../org/apache/xpath/axes/AxesWalker.html">AxesWalker</A>&nbsp;walker)</PRE>
<DL>
<DD><i><font size="-1" color="#00FF00">**For advanced use only** </font></i><meta name="usage" content="advanced"/>
 Remove a walker from the waiting list.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>walker</CODE> - A walker that is no longer waiting.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xpath/axes/AxesWalker.html"><CODE>AxesWalker</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getFoundLast()"><!-- --></A><H3>
getFoundLast</H3>
<PRE>
public final boolean <B>getFoundLast</B>()</PRE>
<DL>
<DD>Tells if we've found the last node yet.<DD><DL>
<DT><B>Returns:</B><DD>true if the last nextNode returned null.</DL>
</DD>
</DL>
<HR>

<A NAME="getXPathContext()"><!-- --></A><H3>
getXPathContext</H3>
<PRE>
public final <A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> <B>getXPathContext</B>()</PRE>
<DL>
<DD>The XPath execution context we are operating on.<DD><DL>
<DT><B>Returns:</B><DD>XPath execution context this iterator is operating on,
 or null if initContext has not been called.</DL>
</DD>
</DL>
<HR>

<A NAME="getDOMHelper()"><!-- --></A><H3>
getDOMHelper</H3>
<PRE>
public final <A HREF="../../../../org/apache/xpath/DOMHelper.html">DOMHelper</A> <B>getDOMHelper</B>()</PRE>
<DL>
<DD>The DOM helper for the given context;<DD><DL>
<DT><B>Returns:</B><DD>The DOMHelper that should be used,
 or null if initContext has not been called.</DL>
</DD>
</DL>
<HR>

<A NAME="getContext()"><!-- --></A><H3>
getContext</H3>
<PRE>
public final <A HREF="../../../../org/w3c/dom/Node.html">Node</A> <B>getContext</B>()</PRE>
<DL>
<DD>The node context for the iterator.<DD><DL>
<DT><B>Returns:</B><DD>The node context, same as getRoot().</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentContextNode()"><!-- --></A><H3>
getCurrentContextNode</H3>
<PRE>
public final <A HREF="../../../../org/w3c/dom/Node.html">Node</A> <B>getCurrentContextNode</B>()</PRE>
<DL>
<DD>The node context from where the expression is being
 executed from (i.e. for current() support).<DD><DL>
<DT><B>Returns:</B><DD>The top-level node context of the entire expression.</DL>
</DD>
</DL>
<HR>

<A NAME="setCurrentContextNode(org.w3c.dom.Node)"><!-- --></A><H3>
setCurrentContextNode</H3>
<PRE>
public final void <B>setCurrentContextNode</B>(<A HREF="../../../../org/w3c/dom/Node.html">Node</A>&nbsp;n)</PRE>
<DL>
<DD>Set the current context node for this iterator.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Must be a non-null reference to the node context.</DL>
</DD>
</DL>
<HR>

<A NAME="getPrefixResolver()"><!-- --></A><H3>
getPrefixResolver</H3>
<PRE>
public final <A HREF="../../../../org/apache/xml/utils/PrefixResolver.html">PrefixResolver</A> <B>getPrefixResolver</B>()</PRE>
<DL>
<DD>Return the saved reference to the prefix resolver that
 was in effect when this iterator was created.<DD><DL>
<DT><B>Returns:</B><DD>The prefix resolver or this iterator, which may be null.</DL>
</DD>
</DL>
<HR>

<A NAME="getLast()"><!-- --></A><H3>
getLast</H3>
<PRE>
public int <B>getLast</B>()</PRE>
<DL>
<DD>Get the index of the last node in the iteration.<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><DT><B>Returns:</B><DD>the index of the last node in the iteration.</DL>
</DD>
</DL>
<HR>

<A NAME="setLast(int)"><!-- --></A><H3>
setLast</H3>
<PRE>
public void <B>setLast</B>(int&nbsp;last)</PRE>
<DL>
<DD>Set the index of the last node in the iteration.<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><DT><B>Parameters:</B><DD><CODE>last</CODE> - the index of the last node in the iteration.</DL>
</DD>
</DL>
<HR>

<A NAME="getLastPos(org.apache.xpath.XPathContext)"><!-- --></A><H3>
getLastPos</H3>
<PRE>
public int <B>getLastPos</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A>&nbsp;xctxt)</PRE>
<DL>
<DD>Get the index of the last node that can be itterated to.
 This probably will need to be overridded by derived classes.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - XPath runtime context.<DT><B>Returns:</B><DD>the index of the last node that can be itterated to.<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getLastPos(org.apache.xpath.XPathContext)">getLastPos</A> in class <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">PredicatedNodeTest</A></DL>
</DD>
</DL>
<HR>

<A NAME="canTraverseOutsideSubtree()"><!-- --></A><H3>
canTraverseOutsideSubtree</H3>
<PRE>
public boolean <B>canTraverseOutsideSubtree</B>()</PRE>
<DL>
<DD>Tell if this expression or it's subexpressions can traverse outside 
 the current subtree.<DD><DL>
<DT><B>Returns:</B><DD>true if traversal outside the context node's subtree can occur.<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#canTraverseOutsideSubtree()">canTraverseOutsideSubtree</A> in class <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">PredicatedNodeTest</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LocPathIterator.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xpath/axes/FollowingWalker.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xpath/axes/NamespaceWalker.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>  &nbsp;
&nbsp;<A HREF="LocPathIterator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright  2000 Apache XML Project. All Rights Reserved.
</BODY>
</HTML>