Package io.delta.kernel.internal.replay

Class PaginatedScanFilesIteratorImpl

Object

io.delta.kernel.internal.replay.PaginatedScanFilesIteratorImpl

All Implemented Interfaces:

PaginatedScanFilesIterator, CloseableIterator<FilteredColumnarBatch>, Closeable, AutoCloseable, Iterator<FilteredColumnarBatch>

public class PaginatedScanFilesIteratorImpl
extends Object
implements PaginatedScanFilesIterator

Implementation of PaginatedScanFilesIterator

Nested Class Summary

Nested classes/interfaces inherited from interface io.delta.kernel.utils.CloseableIterator

CloseableIterator.BreakableFilterResult

Constructor Summary

Constructors

Constructor	Description
PaginatedScanFilesIteratorImpl(CloseableIterator<FilteredColumnarBatch> baseFilteredScanFilesIter, PaginationContext paginationContext)	Constructs a paginated iterator over scan files on top of a given filtered scan files iterator and pagination context.

Method Summary

Modifier and Type	Method	Description
void	close()
Optional<Row>	getCurrentPageToken()	Returns a page token representing the position of the last consumed batch, corresponding to the most recent next() call.
boolean	hasNext()	Returns true if the iteration has more elements.
FilteredColumnarBatch	next()	Returns the next element in the iteration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.delta.kernel.utils.CloseableIterator

breakableFilter, combine, filter, flatMap, map, takeWhile, toInMemoryList

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Details

PaginatedScanFilesIteratorImpl

public PaginatedScanFilesIteratorImpl(CloseableIterator<FilteredColumnarBatch> baseFilteredScanFilesIter,
 PaginationContext paginationContext)

Constructs a paginated iterator over scan files on top of a given filtered scan files iterator and pagination context.

Parameters:

baseFilteredScanFilesIter - The underlying scan files iterator with data skipping and partition pruning applied. This iterator serves as the source of filtered scan results for pagination.

paginationContext - The pagination context that carries pagination-related information, such as the maximum number of files to return in a page.

Method Details

getCurrentPageToken

public Optional<Row> getCurrentPageToken()

Returns a page token representing the position of the last consumed batch, corresponding to the most recent next() call.

Note: This method can be called after the paginated iterator has been closed.

Specified by:

getCurrentPageToken in interface PaginatedScanFilesIterator

hasNext

public boolean hasNext()

Description copied from interface: CloseableIterator

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Specified by:

hasNext in interface CloseableIterator<FilteredColumnarBatch>

Specified by:

hasNext in interface Iterator<FilteredColumnarBatch>

Returns:

true if the iteration has more elements

next

public FilteredColumnarBatch next()

Description copied from interface: CloseableIterator

Returns the next element in the iteration.

Specified by:

next in interface CloseableIterator<FilteredColumnarBatch>

Specified by:

next in interface Iterator<FilteredColumnarBatch>

Returns:

the next element in the iteration

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException