com.mapr.ojai.store.impl

Class AbstractDocumentStream

java.lang.Object

com.mapr.ojai.store.impl.AbstractDocumentStream

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<org.ojai.Document>, org.ojai.DocumentStream

Direct Known Subclasses:

AbstractDocumentFilter, QueryDocumentStream

public abstract class AbstractDocumentStream
extends java.lang.Object
implements org.ojai.DocumentStream

Generic implementation of DocumentStream that provides access to both the streaming and iterator versions of result Document retrieval.

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
AbstractDocumentStream()

Method Summary

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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojai.DocumentStream

getQueryPlan, iterator

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

AbstractDocumentStream

public AbstractDocumentStream()

Method Detail

checkState

protected void checkState()

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

Throws:

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

isCanceled

public boolean isCanceled()

Find out if the query is canceled or not.

Returns:

true if the query has been canceled

isClosed

public boolean isClosed()

Find out if the stream is canceled or not.

Returns:

true if the stream has been closed

cancelQuery

protected void cancelQuery()

Perform whatever steps the derived class requires for canceling.

closeDerived

protected void closeDerived()
                     throws org.ojai.exceptions.OjaiException

Perform whatever steps the derived class requires for closing. Note that the object's lock/monitor will be held, as this is called by the final synchronized close() method.

Throws:

org.ojai.exceptions.OjaiException

close

public final void close()
                 throws org.ojai.exceptions.OjaiException

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

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface org.ojai.DocumentStream

Throws:

org.ojai.exceptions.OjaiException

documentReaders

public java.lang.Iterable<org.ojai.DocumentReader> documentReaders()

Specified by:

documentReaders in interface org.ojai.DocumentStream

streamTo

public 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.

Specified by:

streamTo in interface org.ojai.DocumentStream