org.ojai

Interface DocumentStream

All Superinterfaces:

AutoCloseable, Iterable<Document>

All Known Subinterfaces:

QueryResult

All Known Implementing Classes:

DocumentStreamBase, EmptyDocumentStream, EmptyQueryResult, QueryResultBase

@API.Public
 @API.NotThreadSafe
public interface DocumentStream
extends AutoCloseable, Iterable<Document>

A stream of documents. Implements Iterable but only one call is allows to iterator() or readerIterator(). Only one of these iterators can be retrieved from the stream.

Method Summary

Modifier and Type	Method and Description
void	close() Overridden to remove checked exception
Iterable<DocumentReader>	documentReaders() Returns an Iterable over a set of DocumentReader.
Iterator<Document>	iterator() Returns an iterator over a set of Document.
void	streamTo(DocumentListener listener) Streams all the documents in this DocumentStream to the specified listener.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

streamTo

void streamTo(@API.NonNullable
              DocumentListener listener)

Streams all the documents in this DocumentStream to the specified listener.

Parameters:

listener - a DocumentListener which is notified of Documents as they arrive

Throws:

StreamInUseException - if an iterator is already retrieved from this DocumentStream

iterator

Iterator<Document> iterator()

Returns an iterator over a set of Document.

Specified by:

iterator in interface Iterable<Document>

Throws:

StreamInUseException - if an iterator is already retrieved from this DocumentStream

documentReaders

Iterable<DocumentReader> documentReaders()

Returns an Iterable over a set of DocumentReader.

Throws:

StreamInUseException - if an iterator is already retrieved from this DocumentStream

close

void close()
    throws OjaiException

Overridden to remove checked exception

Specified by:

close in interface AutoCloseable

Throws:

OjaiException