org.apache.flink.connector.file.src.impl

Class FileRecords<T>

java.lang.Object

org.apache.flink.connector.file.src.impl.FileRecords<T>

All Implemented Interfaces:

RecordsWithSplitIds<RecordAndPosition<T>>

@Internal
public final class FileRecords<T>
extends Object
implements RecordsWithSplitIds<RecordAndPosition<T>>

A collection of records for one file split.

This is essentially a slim wrapper around the BulkFormat.RecordIterator that only adds information about the current split, or finished splits (to keep knowledge about current split IDs out of the reader formats).

Method Summary

Modifier and Type	Method and Description
static <T> FileRecords<T>	finishedSplit(String splitId)
Set<String>	finishedSplits() Get the finished splits.
static <T> FileRecords<T>	forRecords(String splitId, BulkFormat.RecordIterator<T> recordsForSplit)
RecordAndPosition<T>	nextRecordFromSplit() Gets the next record from the current split.
String	nextSplit() Moves to the next split.
void	recycle() This method is called when all records from this batch have been emitted.

Methods inherited from class java.lang.Object

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

Method Detail

nextSplit

@Nullable
public String nextSplit()

Description copied from interface: RecordsWithSplitIds

Moves to the next split. This method is also called initially to move to the first split. Returns null, if no splits are left.

Specified by:

nextSplit in interface RecordsWithSplitIds<RecordAndPosition<T>>

nextRecordFromSplit

@Nullable
public RecordAndPosition<T> nextRecordFromSplit()

Description copied from interface: RecordsWithSplitIds

Gets the next record from the current split. Returns null if no more records are left in this split.

Specified by:

nextRecordFromSplit in interface RecordsWithSplitIds<RecordAndPosition<T>>

recycle

public void recycle()

Description copied from interface: RecordsWithSplitIds

This method is called when all records from this batch have been emitted.

Overriding this method gives implementations the opportunity to recycle/reuse this object, which is a performance optimization that is important for cases where the record objects are large or otherwise heavy to allocate.

Specified by:

recycle in interface RecordsWithSplitIds<RecordAndPosition<T>>

finishedSplits

public Set<String> finishedSplits()

Description copied from interface: RecordsWithSplitIds

Get the finished splits.

Specified by:

finishedSplits in interface RecordsWithSplitIds<RecordAndPosition<T>>

Returns:

the finished splits after this RecordsWithSplitIds is returned.

forRecords

public static <T> FileRecords<T> forRecords(String splitId,
                                            BulkFormat.RecordIterator<T> recordsForSplit)

finishedSplit

public static <T> FileRecords<T> finishedSplit(String splitId)