public abstract class AbstractDocumentStream
extends java.lang.Object
implements org.ojai.DocumentStream
| Modifier and Type | Field and Description |
|---|---|
protected boolean |
isUsed
Indicates that one of documentReaders(), iterator(), or streamTo() has been
called.
|
| Constructor and Description |
|---|
AbstractDocumentStream() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
cancelQuery()
Perform whatever steps the derived class requires for canceling.
|
protected void |
checkState()
Checks to see that the state is valid (open, not canceled or closed) for requesting
data.
|
void |
close()
If a derived class requires any closing steps, override
closeDerived(). |
protected void |
closeDerived()
Perform whatever steps the derived class requires for closing.
|
java.lang.Iterable<org.ojai.DocumentReader> |
documentReaders() |
boolean |
isCanceled()
Find out if the query is canceled or not.
|
boolean |
isClosed()
Find out if the stream is canceled or not.
|
void |
streamTo(org.ojai.DocumentListener docListener)
Overriding classes must call this at the end of their own
successful streamTo() in order to mark the abstract stream as used.
|
protected boolean isUsed
protected void checkState()
java.lang.IllegalStateException - if the stream is closed or if one of the data retrieval
methods (documentReaders(), iterator(), or streamTo()) has been used once alreadypublic boolean isCanceled()
public boolean isClosed()
protected void cancelQuery()
protected void closeDerived()
throws org.ojai.exceptions.OjaiException
close() method.org.ojai.exceptions.OjaiExceptionpublic final void close()
throws org.ojai.exceptions.OjaiException
closeDerived().close in interface java.lang.AutoCloseableclose in interface org.ojai.DocumentStreamorg.ojai.exceptions.OjaiExceptionpublic java.lang.Iterable<org.ojai.DocumentReader> documentReaders()
documentReaders in interface org.ojai.DocumentStreampublic void streamTo(org.ojai.DocumentListener docListener)
streamTo in interface org.ojai.DocumentStream