org.apache.iceberg

Interface ContentScanTask<F extends ContentFile<F>>

Type Parameters:

F - the Java class of the content file

All Superinterfaces:

ScanTask, java.io.Serializable

All Known Subinterfaces:

AddedRowsScanTask, DataTask, DeletedDataFileScanTask, DeletedRowsScanTask, FileScanTask

public interface ContentScanTask<F extends ContentFile<F>>
extends ScanTask

A scan task over a range of bytes in a content file.

Method Summary

Modifier and Type	Method and Description
F	file() The file to scan.
long	length() The number of bytes to scan from the start() position in the file.
Expression	residual() Returns the residual expression that should be applied to rows in this file scan.
PartitionSpec	spec() The spec used to store this file.
long	start() The starting position of this scan range in the file.

Methods inherited from interface org.apache.iceberg.ScanTask

asCombinedScanTask, asDataTask, asFileScanTask, filesCount, isDataTask, isFileScanTask, sizeBytes

Method Detail

file

F file()

The file to scan.

Returns:

the file to scan

spec

PartitionSpec spec()

The spec used to store this file.

Returns:

the partition spec from this file's manifest

start

long start()

The starting position of this scan range in the file.

Returns:

the start position of this scan range

length

long length()

The number of bytes to scan from the start() position in the file.

Returns:

the length of this scan range in bytes

residual

Expression residual()

Returns the residual expression that should be applied to rows in this file scan.

The residual expression for a file is a filter expression created by partially evaluating the scan's filter using the file's partition data.

Returns:

a residual expression to apply to rows from this scan