public class WrappingIterator extends Object implements AxisIterator
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD| Constructor and Description |
|---|
WrappingIterator(AxisIterator base,
WrappingFunction function,
VirtualNode parent)
Create a WrappingIterator
|
| Modifier and Type | Method and Description |
|---|---|
Sequence |
atomize()
Return the atomized value of the current node.
|
void |
close()
Close the iterator.
|
NodeInfo |
current()
Get the current item in the sequence.
|
AxisIterator |
getAnother()
Get another iterator over the same sequence of items, positioned at the
start of the sequence.
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
CharSequence |
getStringValue()
Return the string value of the current node.
|
AxisIterator |
iterateAxis(byte axis,
NodeTest test)
Return an iterator over an axis, starting at the current node.
|
boolean |
moveNext()
Move to the next node, without returning it.
|
NodeInfo |
next()
Get the next item in the sequence.
|
int |
position()
Get the current position
|
public WrappingIterator(AxisIterator base, WrappingFunction function, VirtualNode parent)
base - The underlying iteratorparent - If all the nodes to be wrapped have the same parent,
it can be specified here. Otherwise specify null.public boolean moveNext()
moveNext in interface AxisIteratorpublic NodeInfo next()
UnfailingIteratornext in interface SequenceIteratornext in interface AxisIteratornext in interface UnfailingIteratorpublic NodeInfo current()
UnfailingIteratorcurrent in interface SequenceIteratorcurrent in interface AxisIteratorcurrent in interface UnfailingIteratorpublic int position()
UnfailingIteratorposition in interface SequenceIteratorposition in interface UnfailingIteratorpublic void close()
SequenceIterator(Currently, closing an iterator is important only when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.)
close in interface SequenceIteratorpublic AxisIterator iterateAxis(byte axis, NodeTest test)
iterateAxis in interface AxisIteratoraxis - the axis to iterate over, using a constant such as
AxisInfo.CHILDtest - a predicate to apply to the nodes before returning them.NullPointerException - if there is no current nodepublic Sequence atomize() throws XPathException
atomize in interface AxisIteratorNullPointerException - if there is no current nodeXPathException - if the current node
cannot be atomized, for example because it is an element node with
element-only content.public CharSequence getStringValue()
getStringValue in interface AxisIteratorNullPointerException - if there is no current nodepublic AxisIterator getAnother()
UnfailingIteratorgetAnother in interface SequenceIteratorgetAnother in interface AxisIteratorgetAnother in interface UnfailingIteratorpublic int getProperties()
getProperties in interface SequenceIteratorSequenceIterator.GROUNDED, SequenceIterator.LAST_POSITION_FINDER,
and SequenceIterator.LOOKAHEAD. It is always
acceptable to return the value zero, indicating that there are no known special properties.
It is acceptable for the properties of the iterator to change depending on its state.Copyright (c) 2004-2013 Saxonica Limited. All rights reserved.