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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Thu Mar 15 14:18:36 EST 2001 -->
<TITLE>
Xalan-Java 2: Class UnionPathIterator
</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/UnionPathIterator.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/axes/SelfWalkerOneStep.html"><B>PREV CLASS</B></A>
<A HREF="../../../../org/apache/xpath/axes/WalkerFactory.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="UnionPathIterator.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.axes</FONT>
<BR>
Class UnionPathIterator</H2>
<PRE>
java.lang.Object
|
+--<A HREF="../../../../org/apache/xpath/Expression.html">org.apache.xpath.Expression</A>
|
+--<B>org.apache.xpath.axes.UnionPathIterator</B>
</PRE>
<HR>
<DL>
<DT>public class <B>UnionPathIterator</B><DT>extends <A HREF="../../../../org/apache/xpath/Expression.html">Expression</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></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-UnionExpr">UnionExpr</a>.
As each node is iterated via nextNode(), the node is also stored
in the NodeVector, so that previousNode() can easily be done.
<P>
<DL>
<DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.xpath.axes.UnionPathIterator">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/axes/UnionPathIterator.html#UnionPathIterator()">UnionPathIterator</A></B>()</CODE>
<BR>
Constructor to create an instance which you can add location paths to.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.html#UnionPathIterator(org.apache.xpath.compiler.Compiler, int)">UnionPathIterator</A></B>(<A HREF="../../../../org/apache/xpath/compiler/Compiler.html">Compiler</A> compiler,
int opPos)</CODE>
<BR>
Create a UnionPathIterator object, including creation
of location path iterators from the opcode list, and call back
into the Compiler to create predicate expressions.</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/axes/UnionPathIterator.html#addIterator(org.apache.xpath.axes.LocPathIterator)">addIterator</A></B>(<A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html">LocPathIterator</A> iter)</CODE>
<BR>
Add an iterator to the union 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/axes/UnionPathIterator.html#clone()">clone</A></B>()</CODE>
<BR>
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> <A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.html#cloneWithReset()">cloneWithReset</A></B>()</CODE>
<BR>
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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.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/apache/xpath/objects/XObject.html">XObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.html#execute(org.apache.xpath.XPathContext)">execute</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
<BR>
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> <A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.html#getCurrentContextNode()">getCurrentContextNode</A></B>()</CODE>
<BR>
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> <A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.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/axes/UnionPathIterator.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/axes/UnionPathIterator.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/axes/UnionPathIterator.html#getFilter()">getFilter</A></B>()</CODE>
<BR>
The filter 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/axes/UnionPathIterator.html#getLast()">getLast</A></B>()</CODE>
<BR>
Get the index of the last node in the itteration.</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/axes/UnionPathIterator.html#getRoot()">getRoot</A></B>()</CODE>
<BR>
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> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.html#initContext(org.apache.xpath.XPathContext)">initContext</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> execContext)</CODE>
<BR>
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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.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/axes/UnionPathIterator.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/axes/UnionPathIterator.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/axes/UnionPathIterator.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/axes/UnionPathIterator.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/axes/UnionPathIterator.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/axes/UnionPathIterator.html#setLast(int)">setLast</A></B>(int last)</CODE>
<BR>
Set the index of the last node in the itteration.</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/axes/UnionPathIterator.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/axes/UnionPathIterator.html#size()">size</A></B>()</CODE>
<BR>
Get the length of the list.</TD>
</TR>
</TABLE>
<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#canTraverseOutsideSubtree()">canTraverseOutsideSubtree</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>
<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="UnionPathIterator()"><!-- --></A><H3>
UnionPathIterator</H3>
<PRE>
public <B>UnionPathIterator</B>()</PRE>
<DL>
<DD>Constructor to create an instance which you can add location paths to.</DL>
<HR>
<A NAME="UnionPathIterator(org.apache.xpath.compiler.Compiler, int)"><!-- --></A><H3>
UnionPathIterator</H3>
<PRE>
public <B>UnionPathIterator</B>(<A HREF="../../../../org/apache/xpath/compiler/Compiler.html">Compiler</A> compiler,
int opPos)
throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
<DL>
<DD>Create a UnionPathIterator object, including creation
of location path iterators 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> - </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="initContext(org.apache.xpath.XPathContext)"><!-- --></A><H3>
initContext</H3>
<PRE>
public void <B>initContext</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> 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="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="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> 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> - <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext)">execute</A> in class <A HREF="../../../../org/apache/xpath/Expression.html">Expression</A></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.<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="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.</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 length of this list, or zero is this is not a cached list.</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 the iteration has not yet begun.</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.<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>A bit set that tells what node types to show (NodeFilter.SHOW_ALL at
the iterator level).</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.<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.</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 context node of 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>true.</DL>
</DD>
</DL>
<HR>
<A NAME="addIterator(org.apache.xpath.axes.LocPathIterator)"><!-- --></A><H3>
addIterator</H3>
<PRE>
public void <B>addIterator</B>(<A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html">LocPathIterator</A> iter)</PRE>
<DL>
<DD>Add an iterator to the union list.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>iter</CODE> - non-null reference to a location path iterator.</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 - </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 - </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="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> - The index to run to, or -1 if the iterator
should run to the end.</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>A value greater than or equal to zero that indicates the next
node position to fetch.</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.<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="getCurrentContextNode()"><!-- --></A><H3>
getCurrentContextNode</H3>
<PRE>
public <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="getLast()"><!-- --></A><H3>
getLast</H3>
<PRE>
public int <B>getLast</B>()</PRE>
<DL>
<DD>Get the index of the last node in the itteration.<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>Set the index of the last node in the itteration.<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/UnionPathIterator.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/axes/SelfWalkerOneStep.html"><B>PREV CLASS</B></A>
<A HREF="../../../../org/apache/xpath/axes/WalkerFactory.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="UnionPathIterator.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>
|
