|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.tree.wrapper.WrappingIterator
public class WrappingIterator
A WrappingIterator delivers wrappers for the nodes delivered by its underlying iterator. It is used when no whitespace stripping is actually needed, e.g. for the attribute axis. But we still need to create wrappers, so that further iteration remains in the virtual layer rather than switching to the real nodes.
Field Summary |
---|
Fields inherited from interface net.sf.saxon.om.SequenceIterator |
---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
Constructor Summary | |
---|---|
WrappingIterator(AxisIterator base,
WrappingFunction function,
VirtualNode parent)
Create a WrappingIterator |
Method Summary | |
---|---|
Value |
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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.Method Detail |
---|
public boolean moveNext()
moveNext
in interface AxisIterator
public NodeInfo next()
UnfailingIterator
next
in interface SequenceIterator
next
in interface AxisIterator
next
in interface UnfailingIterator
public NodeInfo current()
UnfailingIterator
current
in interface SequenceIterator
current
in interface AxisIterator
current
in interface UnfailingIterator
public int position()
UnfailingIterator
position
in interface SequenceIterator
position
in interface UnfailingIterator
public 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 SequenceIterator
public AxisIterator iterateAxis(byte axis, NodeTest test)
iterateAxis
in interface AxisIterator
axis
- the axis to iterate over, using a constant such as
Axis.CHILD
test
- a predicate to apply to the nodes before returning them.
NullPointerException
- if there is no current nodepublic Value atomize() throws XPathException
atomize
in interface AxisIterator
NullPointerException
- if there is no current node
XPathException
- 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 AxisIterator
NullPointerException
- if there is no current nodepublic AxisIterator getAnother()
UnfailingIterator
getAnother
in interface SequenceIterator
getAnother
in interface AxisIterator
getAnother
in interface UnfailingIterator
public int getProperties()
getProperties
in interface SequenceIterator
SequenceIterator.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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |