Class PositionIterator

    • Method Detail

      • make

        public static SequenceIterator make​(SequenceIterator base,
                                            int min,
                                            int max)
                                     throws XPathException
        Static factory method. Creates a PositionIterator, unless the base Iterator is an ArrayIterator, in which case it optimizes by creating a new ArrayIterator directly over the underlying array. This optimization is important when doing recursion over a node-set using repeated calls of $nodes[position()>1]
        Parameters:
        base - An iteration of the items to be filtered
        min - The position of the first item to be included (base 1)
        max - The position of the last item to be included (base 1)
        Throws:
        XPathException
      • hasNext

        public boolean hasNext()
        Test whether there are any more items available in the enumeration
        Specified by:
        hasNext in interface LookaheadIterator
        Returns:
        true if there are more items in the sequence
      • next

        public Item next()
                  throws XPathException
        Get the next item if there is one
        Specified by:
        next in interface SequenceIterator
        Returns:
        the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.
        Throws:
        XPathException - if an error occurs retrieving the next item
      • current

        public Item current()
        Description copied from interface: SequenceIterator
        Get the current value in the sequence (the one returned by the most recent call on next()). This will be null before the first call of next(). This method does not change the state of the iterator.
        Specified by:
        current in interface SequenceIterator
        Returns:
        the current item, the one most recently returned by a call on next(). Returns null if next() has not been called, or if the end of the sequence has been reached.
      • position

        public int position()
        Description copied from interface: SequenceIterator
        Get the current position. This will usually be zero before the first call on next(), otherwise it will be the number of times that next() has been called. Once next() has returned null, the preferred action is for subsequent calls on position() to return -1, but not all existing implementations follow this practice. (In particular, the EmptyIterator is stateless, and always returns 0 as the value of position(), whether or not next() has been called.)

        This method does not change the state of the iterator.

        Specified by:
        position in interface SequenceIterator
        Returns:
        the current position, the position of the item returned by the most recent call of next(). This is 1 after next() has been successfully called once, 2 after it has been called twice, and so on. If next() has never been called, the method returns zero. If the end of the sequence has been reached, the value returned will always be <= 0; the preferred value is -1.