com.mapr.ojai.store.impl

Class AbstractDocumentFilter

java.lang.Object

com.mapr.ojai.store.impl.AbstractDocumentStream

com.mapr.ojai.store.impl.AbstractDocumentFilter

All Implemented Interfaces:

com.mapr.db.impl.OjaiQueryProperties, PipelineControl, java.lang.AutoCloseable, java.lang.Iterable<org.ojai.Document>, org.ojai.DocumentStream

Direct Known Subclasses:

CommitWaitStream, DrillPostludeFilter, DrillPreludeFilter, LimitStream, OffsetStream, RowkeyLookup, TimeoutDocumentFilter, TopKStream

public abstract class AbstractDocumentFilter
extends AbstractDocumentStream
implements com.mapr.db.impl.OjaiQueryProperties, PipelineControl

Nested Class Summary

Nested classes/interfaces inherited from interface com.mapr.db.impl.OjaiQueryProperties

com.mapr.db.impl.OjaiQueryProperties.QueryPath

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Iterator<org.ojai.Document>	docIter
protected org.ojai.DocumentStream	upstreamStream

Fields inherited from class com.mapr.ojai.store.impl.AbstractDocumentStream

isUsed

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentFilter(org.ojai.DocumentStream upstreamStream)

Method Summary

Modifier and Type	Method and Description
protected void	closeDerived() Perform whatever steps the derived class requires for closing.
java.lang.String	getIndexUsed()
com.mapr.db.impl.OjaiQueryProperties.QueryPath	getQueryPath()
org.ojai.Document	getQueryPlan()
java.util.Iterator<org.ojai.Document>	iterator()
void	setDesiredRows(LongValue longValue) Provide a means for an element to query how many rows it would be desirable for it to produce at any given moment.

Methods inherited from class com.mapr.ojai.store.impl.AbstractDocumentStream

cancelQuery, checkState, close, documentReaders, isCanceled, isClosed, streamTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mapr.db.impl.OjaiQueryProperties

getQueryPlan

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

upstreamStream

protected final org.ojai.DocumentStream upstreamStream

docIter

protected java.util.Iterator<org.ojai.Document> docIter

Constructor Detail

AbstractDocumentFilter

public AbstractDocumentFilter(org.ojai.DocumentStream upstreamStream)

Method Detail

iterator

public java.util.Iterator<org.ojai.Document> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.ojai.Document>

Specified by:

iterator in interface org.ojai.DocumentStream

closeDerived

protected void closeDerived()

Description copied from class: AbstractDocumentStream

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 AbstractDocumentStream.close() method.

Overrides:

closeDerived in class AbstractDocumentStream

getQueryPath

public com.mapr.db.impl.OjaiQueryProperties.QueryPath getQueryPath()

Specified by:

getQueryPath in interface com.mapr.db.impl.OjaiQueryProperties

getIndexUsed

public java.lang.String getIndexUsed()

Specified by:

getIndexUsed in interface com.mapr.db.impl.OjaiQueryProperties

getQueryPlan

public org.ojai.Document getQueryPlan()

Specified by:

getQueryPlan in interface org.ojai.DocumentStream

setDesiredRows

public void setDesiredRows(LongValue longValue)

Description copied from interface: PipelineControl

Provide a means for an element to query how many rows it would be desirable for it to produce at any given moment. The returned value may change over time.

Specified by:

setDesiredRows in interface PipelineControl

Parameters:

longValue - interface for requesting the currently desired number of rows