Class DocumentOrderIterator

  • All Implemented Interfaces:, java.lang.AutoCloseable, SequenceIterator

    public final class DocumentOrderIterator
    extends java.lang.Object
    implements SequenceIterator
    DocumentOrderIterator takes as input an iteration of nodes in any order, and returns as output an iteration of the same nodes in document order, eliminating any duplicates. An error occurs if the input sequence contains items that are not nodes.
    • Constructor Detail

      • DocumentOrderIterator

        public DocumentOrderIterator​(SequenceIterator base,
                                     java.util.Comparator<? super NodeInfo> comparer)
        Iterate over a sequence in document order.
        base - the input sequence to be sorted
        comparer - the comparer used for comparing node positions
    • Method Detail

      • next

        public NodeInfo next()
        Description copied from interface: SequenceIterator
        Get the next item in the sequence. This method changes the state of the iterator.
        Specified by:
        next in interface SequenceIterator
        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.