Class UnparsedTextIterator

    • Field Detail

      • reader

        java.io.LineNumberReader reader
      • absoluteURI

        java.net.URI absoluteURI
      • position

        int position
      • encoding

        java.lang.String encoding
      • location

        javax.xml.transform.SourceLocator location
    • Constructor Detail

      • UnparsedTextIterator

        public UnparsedTextIterator​(java.net.URI absoluteURI,
                                    XPathContext context,
                                    java.lang.String encoding,
                                    javax.xml.transform.SourceLocator location)
                             throws XPathException
        Create a UnparsedTextIterator over a given file
        Parameters:
        absoluteURI - the URI identifying the file
        context - the dynamic evaluation context
        encoding - the expected encoding of the file
        location - the location of the instruction being executed
        Throws:
        XPathException - if a dynamic error occurs
    • Method Detail

      • next

        public StringValue next()
                         throws XPathException
        Description copied from interface: SequenceIterator
        Get the next item in the sequence. This method changes the state of the iterator, in particular it affects the result of subsequent calls of position() and current().
        Specified by:
        next in interface SequenceIterator<StringValue>
        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
      • position

        public int position()
        The line position currently being read
        Specified by:
        position in interface SequenceIterator<StringValue>
        Returns:
        returns the current line in the file
      • 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<StringValue>
      • getAnother

        public SequenceIterator<StringValue> getAnother()
                                                 throws XPathException
        Description copied from interface: SequenceIterator
        Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence.

        This method allows access to all the items in the sequence without disturbing the current position of the iterator. Internally, its main use is in evaluating the last() function.

        This method does not change the state of the iterator.

        Specified by:
        getAnother in interface SequenceIterator<StringValue>
        Returns:
        a SequenceIterator that iterates over the same items, positioned before the first item
        Throws:
        XPathException - if any error occurs