Package net.sf.saxon.tree.wrapper
Class WrappingIterator
- java.lang.Object
-
- net.sf.saxon.tree.wrapper.WrappingIterator
-
- All Implemented Interfaces:
SequenceIterator
,AxisIterator
,UnfailingIterator
public class WrappingIterator extends java.lang.Object implements AxisIterator
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 Modifier and Type Field Description (package private) boolean
atomizing
(package private) AxisIterator
base
(package private) NodeInfo
current
(package private) VirtualNode
parent
(package private) WrappingFunction
wrappingFunction
-
Fields inherited from interface net.sf.saxon.om.SequenceIterator
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
-
-
Constructor Summary
Constructors Constructor Description WrappingIterator(AxisIterator base, WrappingFunction function, VirtualNode parent)
Create a WrappingIterator
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.java.lang.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
-
-
-
Field Detail
-
base
AxisIterator base
-
parent
VirtualNode parent
-
current
NodeInfo current
-
atomizing
boolean atomizing
-
wrappingFunction
WrappingFunction wrappingFunction
-
-
Constructor Detail
-
WrappingIterator
public WrappingIterator(AxisIterator base, WrappingFunction function, VirtualNode parent)
Create a WrappingIterator- Parameters:
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
-
moveNext
public boolean moveNext()
Move to the next node, without returning it. Returns true if there is a next node, false if the end of the sequence has been reached. After calling this method, the current node may be retrieved using the current() function.- Specified by:
moveNext
in interfaceAxisIterator
- Returns:
- true if there is a next node, false if the end of the sequence has been reached
-
next
public NodeInfo next()
Description copied from interface:UnfailingIterator
Get the next item in the sequence.- Specified by:
next
in interfaceAxisIterator
- Specified by:
next
in interfaceSequenceIterator
- Specified by:
next
in interfaceUnfailingIterator
- Returns:
- the next Item. If there are no more nodes, return null.
-
current
public NodeInfo current()
Description copied from interface:UnfailingIterator
Get the current item in the sequence.- Specified by:
current
in interfaceAxisIterator
- Specified by:
current
in interfaceSequenceIterator
- Specified by:
current
in interfaceUnfailingIterator
- Returns:
- the current item, that is, the item most recently returned by next()
-
position
public int position()
Description copied from interface:UnfailingIterator
Get the current position- Specified by:
position
in interfaceSequenceIterator
- Specified by:
position
in interfaceUnfailingIterator
- Returns:
- the position of the current item (the item most recently returned by next()), starting at 1 for the first node
-
close
public void close()
Description copied from interface:SequenceIterator
Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.(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.)
- Specified by:
close
in interfaceSequenceIterator
-
iterateAxis
public AxisIterator iterateAxis(byte axis, NodeTest test)
Return an iterator over an axis, starting at the current node.- Specified by:
iterateAxis
in interfaceAxisIterator
- Parameters:
axis
- the axis to iterate over, using a constant such asAxis.CHILD
test
- a predicate to apply to the nodes before returning them.- Returns:
- an iterator over an axis, starting at the current node
- Throws:
java.lang.NullPointerException
- if there is no current node
-
atomize
public Value atomize() throws XPathException
Return the atomized value of the current node.- Specified by:
atomize
in interfaceAxisIterator
- Returns:
- the atomized value.
- Throws:
java.lang.NullPointerException
- 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.
-
getStringValue
public java.lang.CharSequence getStringValue()
Return the string value of the current node.- Specified by:
getStringValue
in interfaceAxisIterator
- Returns:
- the string value, as an instance of CharSequence.
- Throws:
java.lang.NullPointerException
- if there is no current node
-
getAnother
public AxisIterator getAnother()
Description copied from interface:UnfailingIterator
Get another iterator over the same sequence of items, positioned at the start of the sequence. It must be possible to call this method at any time, whether none, some, or all of the items in the original iterator have been read. The method is non-destructive: it does not change the state of the original iterator.- Specified by:
getAnother
in interfaceAxisIterator
- Specified by:
getAnother
in interfaceSequenceIterator
- Specified by:
getAnother
in interfaceUnfailingIterator
- Returns:
- a new iterator over the same sequence
-
getProperties
public int getProperties()
Get properties of this iterator, as a bit-significant integer.- Specified by:
getProperties
in interfaceSequenceIterator
- Returns:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.GROUNDED
,SequenceIterator.LAST_POSITION_FINDER
, andSequenceIterator.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.
-
-