org.teiid.query.processor

Class BatchIterator

java.lang.Object

org.teiid.common.buffer.AbstractTupleSource

org.teiid.query.processor.BatchIterator

All Implemented Interfaces:

IndexedTupleSource, TupleSource

public class BatchIterator
extends AbstractTupleSource

A BatchIterator provides an iterator interface to a BatchCollector.BatchProducer. By setting #setBuffer(TupleBuffer), the iterator can copy on read into a TupleBuffer for repeated reading. Note that the saveOnMark buffering only lasts until the next mark is set.

Field Summary

Fields inherited from class org.teiid.common.buffer.AbstractTupleSource

batch, currentTuple

Constructor Summary

Constructors

Constructor and Description
BatchIterator(BatchCollector.BatchProducer source)

Method Summary

Modifier and Type	Method and Description
long	available()
void	closeSource() Closes the Tuple Source.
void	disableSave()
boolean	ensureSave() non-destructive method to set the mark
protected List<?>	finalRow()
protected TupleBatch	getBatch(long row)
TupleBuffer	getBuffer()
protected List<?>	getCurrentTuple()
void	mark() Save the current position that can be restored with a call to IndexedTupleSource.reset()
void	readAhead(long limit)
void	reset() Restore the previous mark and set the mark back to the first position.
void	setBuffer(TupleBuffer buffer, boolean saveOnMark)
void	setPosition(long position) Set the tuple source position

Methods inherited from class org.teiid.common.buffer.AbstractTupleSource

getCurrentIndex, hasNext, nextTuple

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchIterator

public BatchIterator(BatchCollector.BatchProducer source)

Method Detail

getBatch

protected TupleBatch getBatch(long row)
                       throws TeiidComponentException,
                              TeiidProcessingException

Specified by:

getBatch in class AbstractTupleSource

Throws:

TeiidComponentException

TeiidProcessingException

finalRow

protected List<?> finalRow()
                    throws TeiidComponentException,
                           TeiidProcessingException

Specified by:

finalRow in class AbstractTupleSource

Throws:

TeiidComponentException

TeiidProcessingException

getCurrentTuple

protected List<?> getCurrentTuple()
                           throws TeiidComponentException,
                                  BlockedException,
                                  TeiidProcessingException

Overrides:

getCurrentTuple in class AbstractTupleSource

Throws:

TeiidComponentException

BlockedException

TeiidProcessingException

available

public long available()

Specified by:

available in class AbstractTupleSource

setBuffer

public void setBuffer(TupleBuffer buffer,
                      boolean saveOnMark)

closeSource

public void closeSource()

Description copied from interface: TupleSource

Closes the Tuple Source.

Specified by:

closeSource in interface TupleSource

Overrides:

closeSource in class AbstractTupleSource

reset

public void reset()

Description copied from interface: IndexedTupleSource

Restore the previous mark and set the mark back to the first position.

Specified by:

reset in interface IndexedTupleSource

Overrides:

reset in class AbstractTupleSource

mark

public void mark()
          throws TeiidComponentException

Description copied from interface: IndexedTupleSource

Save the current position that can be restored with a call to IndexedTupleSource.reset()

Specified by:

mark in interface IndexedTupleSource

Overrides:

mark in class AbstractTupleSource

Throws:

TeiidComponentException

setPosition

public void setPosition(long position)

Description copied from interface: IndexedTupleSource

Set the tuple source position

Specified by:

setPosition in interface IndexedTupleSource

Overrides:

setPosition in class AbstractTupleSource

ensureSave

public boolean ensureSave()

non-destructive method to set the mark

Returns:

true if the mark was set

disableSave

public void disableSave()

readAhead

public void readAhead(long limit)
               throws TeiidComponentException,
                      TeiidProcessingException

Throws:

TeiidComponentException

TeiidProcessingException

getBuffer

public TupleBuffer getBuffer()