Package net.sf.saxon.tree.iter
Class UnparsedTextIterator
java.lang.Object
net.sf.saxon.tree.iter.UnparsedTextIterator
- All Implemented Interfaces:
SequenceIterator<StringValue>
Class UnparsedTextIterator, iterates over a file line by line
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) URI
(package private) NameChecker
(package private) XPathContext
(package private) StringValue
(package private) String
(package private) SourceLocator
(package private) int
(package private) LineNumberReader
Fields inherited from interface net.sf.saxon.om.SequenceIterator
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
-
Constructor Summary
ConstructorsConstructorDescriptionUnparsedTextIterator
(URI absoluteURI, XPathContext context, String encoding, SourceLocator location) Create a UnparsedTextIterator over a given file -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close the iterator.current()
The current line in the fileGet another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence.int
Get properties of this iterator, as a bit-significant integer.next()
Get the next item in the sequence.int
position()
The line position currently being read
-
Field Details
-
reader
LineNumberReader reader -
checker
NameChecker checker -
absoluteURI
URI absoluteURI -
context
XPathContext context -
current
StringValue current -
position
int position -
encoding
String encoding -
location
SourceLocator location
-
-
Constructor Details
-
UnparsedTextIterator
public UnparsedTextIterator(URI absoluteURI, XPathContext context, String encoding, SourceLocator location) throws XPathException Create a UnparsedTextIterator over a given file- Parameters:
absoluteURI
- the URI identifying the filecontext
- the dynamic evaluation contextencoding
- the expected encoding of the filelocation
- the location of the instruction being executed- Throws:
XPathException
- if a dynamic error occurs
-
-
Method Details
-
next
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 interfaceSequenceIterator<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
-
current
The current line in the file- Specified by:
current
in interfaceSequenceIterator<StringValue>
- Returns:
- returns StringValue: the current line in the file
-
position
public int position()The line position currently being read- Specified by:
position
in interfaceSequenceIterator<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 interfaceSequenceIterator<StringValue>
-
getAnother
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 interfaceSequenceIterator<StringValue>
- Returns:
- a SequenceIterator that iterates over the same items, positioned before the first item
- Throws:
XPathException
- if any error occurs
-
getProperties
public int getProperties()Description copied from interface:SequenceIterator
Get properties of this iterator, as a bit-significant integer.- Specified by:
getProperties
in interfaceSequenceIterator<StringValue>
- 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.
-