com.mapr.ojai.store.impl

Class OffsetStream

java.lang.Object

com.mapr.ojai.store.impl.AbstractDocumentStream

com.mapr.ojai.store.impl.AbstractDocumentFilter

com.mapr.ojai.store.impl.OffsetStream

All Implemented Interfaces:

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

public class OffsetStream
extends AbstractDocumentFilter

Filter that only returns documents after a certain number have already passed.

Nested Class Summary

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

com.mapr.db.impl.OjaiQueryProperties.QueryPath

Field Summary

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

docIter, upstreamStream

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

isUsed

Constructor Summary

Constructors

Constructor and Description
OffsetStream(org.ojai.DocumentStream upstreamStream, long offset) Constructor.

Method Summary

Modifier and Type	Method and Description
void	getQueryPlan(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> planList)
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.AbstractDocumentFilter

closeDerived, getIndexUsed, getQueryPath, getQueryPlan

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 java.lang.Iterable

forEach, spliterator

Constructor Detail

OffsetStream

public OffsetStream(org.ojai.DocumentStream upstreamStream,
                    long offset)

Constructor.

Parameters:

upstreamStream - the upstream document source

executorService - an ExecutorService that can be used for asynchronous streaming

offset - how many documents to skip over

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

Overrides:

iterator in class AbstractDocumentFilter

getQueryPlan

public void getQueryPlan(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> planList)

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

Overrides:

setDesiredRows in class AbstractDocumentFilter

Parameters:

longValue - interface for requesting the currently desired number of rows