org.ojai.base

Class DocumentStreamBase

java.lang.Object

org.ojai.base.DocumentStreamBase

All Implemented Interfaces:

AutoCloseable, Iterable<Document>, DocumentStream

Direct Known Subclasses:

EmptyDocumentStream, QueryResultBase

public abstract class DocumentStreamBase
extends Object
implements DocumentStream

Abstract implementation of DocumentStream.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isUsed Indicates that one of documentReaders(), iterator(), or streamTo() has been called.

Constructor Summary

Constructors

Constructor and Description
DocumentStreamBase()

Method Summary

Modifier and Type	Method and Description
protected void	checkAndSetInUse() Checks to see that the state is valid (open, not canceled or closed) for requesting data.
protected void	checkOpen() Checks to see if the stream is open or not.
void	close() Closes this DocumentStream. If a derived class requires any closing steps, it should override closeDerived().
protected void	closeDerived() Perform whatever steps the derived class requires for closing.
Iterable<DocumentReader>	documentReaders() Returns an Iterable over a set of DocumentReader.
protected Iterable<DocumentReader>	documentReadersDerived()
protected boolean	isClosed()
Iterator<Document>	iterator() Returns an iterator over a set of Document.
protected abstract Iterator<Document>	iteratorDerived() This is the only method deriving class MUST implement.
void	streamTo(DocumentListener docListener) Streams all the documents in this DocumentStream to the specified listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

isUsed

protected boolean isUsed

Indicates that one of documentReaders(), iterator(), or streamTo() has been called.

Constructor Detail

DocumentStreamBase

public DocumentStreamBase()

Method Detail

iteratorDerived

protected abstract Iterator<Document> iteratorDerived()

This is the only method deriving class MUST implement.

closeDerived

protected void closeDerived()
                     throws OjaiException

Perform whatever steps the derived class requires for closing.

Throws:

OjaiException

checkOpen

protected void checkOpen()

Checks to see if the stream is open or not.

Throws:

IllegalStateException - if the stream has been closed

checkAndSetInUse

protected void checkAndSetInUse()

Checks to see that the state is valid (open, not canceled or closed) for requesting data.

Throws:

IllegalStateException - if the stream is closed or if one of the data retrieval methods (documentReaders(), iterator(), or streamTo()) has been used once already

isClosed

protected boolean isClosed()

Returns:

true if the stream has been closed

iterator

public final Iterator<Document> iterator()

Description copied from interface: DocumentStream

Returns an iterator over a set of Document.

Specified by:

iterator in interface Iterable<Document>

Specified by:

iterator in interface DocumentStream

close

public final void close()
                 throws OjaiException

Closes this DocumentStream.

If a derived class requires any closing steps, it should override closeDerived().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DocumentStream

Throws:

OjaiException

documentReadersDerived

protected Iterable<DocumentReader> documentReadersDerived()

documentReaders

public final Iterable<DocumentReader> documentReaders()

Description copied from interface: DocumentStream

Returns an Iterable over a set of DocumentReader.

Specified by:

documentReaders in interface DocumentStream

streamTo

public void streamTo(DocumentListener docListener)

Description copied from interface: DocumentStream

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

Specified by:

streamTo in interface DocumentStream

Parameters:

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