Class NodeWrappingAxisIterator<T extends NodeInfo,​B>

    • Constructor Detail

      • NodeWrappingAxisIterator

        public NodeWrappingAxisIterator​(java.util.Iterator<B> base,
                                        NodeWrappingFunction<B,​T> wrappingFunction)
        Create a SequenceIterator over a given iterator
        Parameters:
        base - the base Iterator
        wrappingFunction - a function that wraps objects of type B in a Saxon NodeInfo
    • Method Detail

      • moveNext

        public boolean moveNext()
        Description copied from interface: AxisIterator
        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 interface AxisIterator<T extends NodeInfo>
        Returns:
        true if there is a next node, false if the end of the sequence has been reached
      • iterateAxis

        public AxisIterator iterateAxis​(byte axis,
                                        NodeTest test)
        Description copied from interface: AxisIterator
        Return an iterator over an axis, starting at the current node.
        Specified by:
        iterateAxis in interface AxisIterator<T extends NodeInfo>
        Parameters:
        axis - the axis to iterate over, using a constant such as Axis.CHILD
        test - a predicate to apply to the nodes before returning them.
        Returns:
        an iterator over an axis, starting at the current node
      • atomize

        public Value atomize()
                      throws XPathException
        Description copied from interface: AxisIterator
        Return the atomized value of the current node.
        Specified by:
        atomize in interface AxisIterator<T extends NodeInfo>
        Returns:
        the atomized value.
        Throws:
        XPathException - 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()
        Description copied from interface: AxisIterator
        Return the string value of the current node.
        Specified by:
        getStringValue in interface AxisIterator<T extends NodeInfo>
        Returns:
        the string value, as an instance of CharSequence.
      • hasNext

        public boolean hasNext()
        Description copied from interface: LookaheadIterator
        Determine whether there are more items to come. Note that this operation is stateless and it is not necessary (or usual) to call it before calling next(). It is used only when there is an explicit need to tell if we are at the last element.

        This method must not be called unless the result of getProperties() on the iterator includes the bit setting SequenceIterator.LOOKAHEAD

        Specified by:
        hasNext in interface LookaheadIterator<T extends NodeInfo>
        Returns:
        true if there are more items in the sequence
      • 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 interface SequenceIterator<T extends NodeInfo>
      • getAnother

        public abstract AxisIterator<T> 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 interface AxisIterator<T extends NodeInfo>
        Specified by:
        getAnother in interface SequenceIterator<T extends NodeInfo>
        Specified by:
        getAnother in interface UnfailingIterator<T extends NodeInfo>
        Returns:
        a new iterator over the same sequence