Interface FilterPredicate

All Known Implementing Classes:

FilterPredicate.And, FilterPredicate.BinaryColumnPredicate, FilterPredicate.BinaryInPredicate, FilterPredicate.BooleanColumnPredicate, FilterPredicate.DateColumnPredicate, FilterPredicate.DecimalColumnPredicate, FilterPredicate.DoubleColumnPredicate, FilterPredicate.FloatColumnPredicate, FilterPredicate.InstantColumnPredicate, FilterPredicate.IntColumnPredicate, FilterPredicate.IntInPredicate, FilterPredicate.IsNotNullPredicate, FilterPredicate.IsNullPredicate, FilterPredicate.LongColumnPredicate, FilterPredicate.LongInPredicate, FilterPredicate.Not, FilterPredicate.Or, FilterPredicate.SignedBinaryColumnPredicate, FilterPredicate.TimeColumnPredicate, FilterPredicate.UUIDColumnPredicate

public sealed interface FilterPredicate
permits FilterPredicate.IntColumnPredicate, FilterPredicate.LongColumnPredicate, FilterPredicate.FloatColumnPredicate, FilterPredicate.DoubleColumnPredicate, FilterPredicate.BooleanColumnPredicate, FilterPredicate.BinaryColumnPredicate, FilterPredicate.SignedBinaryColumnPredicate, FilterPredicate.UUIDColumnPredicate, FilterPredicate.IntInPredicate, FilterPredicate.LongInPredicate, FilterPredicate.BinaryInPredicate, FilterPredicate.DateColumnPredicate, FilterPredicate.InstantColumnPredicate, FilterPredicate.TimeColumnPredicate, FilterPredicate.DecimalColumnPredicate, FilterPredicate.IsNullPredicate, FilterPredicate.IsNotNullPredicate, FilterPredicate.And, FilterPredicate.Or, FilterPredicate.Not

A predicate for filtering row groups based on column statistics.

Filter predicates enable predicate push-down: row groups whose statistics prove that no rows can match the predicate are skipped entirely, avoiding unnecessary I/O and decoding.

Usage examples:

// Simple comparison
FilterPredicate filter = FilterPredicate.gt("age", 21);

// Compound predicate
FilterPredicate filter = FilterPredicate.and(
    FilterPredicate.gtEq("salary", 50000L),
    FilterPredicate.lt("age", 65)
);

// Use with reader
try (ColumnReader reader = fileReader.buildColumnReader("salary").filter(filter).build()) {
    while (reader.nextBatch()) { ... }
}

Null handling

All comparison predicates (eq, notEq, lt, ltEq, gt, gtEq, in, inStrings) follow SQL three-valued logic: comparing a null column value against any operand yields UNKNOWN, and rows whose predicate is UNKNOWN are not returned. In practice this means rows with a null in the tested column are never returned by a comparison predicate. Use isNull / isNotNull for explicit null checks, or or(...) to include null rows alongside a comparison — e.g. or(gt("age", 30), isNull("age")).

not(p) preserves this behavior: rows where p is UNKNOWN stay UNKNOWN under negation and are dropped. The SQL identity not(gt(x, v)) ≡ ltEq(x, v) holds on all rows, including null ones.

This matches the SQL semantics of WHERE predicates and differs from parquet-java's notEq, which treats null <> v as true and therefore includes null rows. To reproduce parquet-java's behavior in Hardwood, write the null-inclusion explicitly: or(notEq("x", v), isNull("x")).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	FilterPredicate.And
static final record	FilterPredicate.BinaryColumnPredicate
static final record	FilterPredicate.BinaryInPredicate
static final record	FilterPredicate.BooleanColumnPredicate
static final record	FilterPredicate.DateColumnPredicate	Predicate for DATE columns.
static final record	FilterPredicate.DecimalColumnPredicate	Predicate for DECIMAL columns.
static final record	FilterPredicate.DoubleColumnPredicate
static final record	FilterPredicate.FloatColumnPredicate
static final record	FilterPredicate.InstantColumnPredicate	Predicate for TIMESTAMP columns.
static final record	FilterPredicate.IntColumnPredicate
static final record	FilterPredicate.IntInPredicate
static final record	FilterPredicate.IsNotNullPredicate	Predicate that matches rows where the column value is not null.
static final record	FilterPredicate.IsNullPredicate	Predicate that matches rows where the column value is null.
static final record	FilterPredicate.LongColumnPredicate
static final record	FilterPredicate.LongInPredicate
static final record	FilterPredicate.Not
static enum	FilterPredicate.Operator
static final record	FilterPredicate.Or
static final record	FilterPredicate.SignedBinaryColumnPredicate	Predicate for decimal columns stored as FIXED_LEN_BYTE_ARRAY, which require signed (two's complement) comparison.
static final record	FilterPredicate.TimeColumnPredicate	Predicate for TIME columns.
static final record	FilterPredicate.UUIDColumnPredicate

Method Summary

Static Methods

Modifier and Type	Method	Description
static FilterPredicate	and(FilterPredicate... filters)
static FilterPredicate	and(FilterPredicate left, FilterPredicate right)
static FilterPredicate	eq(String column, boolean value)
static FilterPredicate	eq(String column, double value)
static FilterPredicate	eq(String column, float value)
static FilterPredicate	eq(String column, int value)
static FilterPredicate	eq(String column, long value)
static FilterPredicate	eq(String column, String value)
static FilterPredicate	eq(String column, BigDecimal value)	Creates an equals predicate for a BigDecimal column (Parquet DECIMAL logical type).
static FilterPredicate	eq(String column, Instant value)	Creates an equals predicate for an Instant column (Parquet TIMESTAMP logical type).
static FilterPredicate	eq(String column, LocalDate value)	Creates an equals predicate for a LocalDate column (Parquet DATE logical type).
static FilterPredicate	eq(String column, LocalTime value)	Creates an equals predicate for a LocalTime column (Parquet TIME logical type).
static FilterPredicate	eq(String column, UUID value)	Creates an equals predicate for a UUID column (Parquet UUID logical type).
static FilterPredicate	gt(String column, double value)
static FilterPredicate	gt(String column, float value)
static FilterPredicate	gt(String column, int value)
static FilterPredicate	gt(String column, long value)
static FilterPredicate	gt(String column, String value)
static FilterPredicate	gt(String column, BigDecimal value)	Creates a greater-than predicate for a BigDecimal column.
static FilterPredicate	gt(String column, Instant value)	Creates a greater-than predicate for an Instant column.
static FilterPredicate	gt(String column, LocalDate value)	Creates a greater-than predicate for a LocalDate column.
static FilterPredicate	gt(String column, LocalTime value)	Creates a greater-than predicate for a LocalTime column.
static FilterPredicate	gt(String column, UUID value)	Creates a greater-than predicate for a UUID column.
static FilterPredicate	gtEq(String column, double value)
static FilterPredicate	gtEq(String column, float value)
static FilterPredicate	gtEq(String column, int value)
static FilterPredicate	gtEq(String column, long value)
static FilterPredicate	gtEq(String column, String value)
static FilterPredicate	gtEq(String column, BigDecimal value)	Creates a greater-than-or-equal predicate for a BigDecimal column.
static FilterPredicate	gtEq(String column, Instant value)	Creates a greater-than-or-equal predicate for an Instant column.
static FilterPredicate	gtEq(String column, LocalDate value)	Creates a greater-than-or-equal predicate for a LocalDate column.
static FilterPredicate	gtEq(String column, LocalTime value)	Creates a greater-than-or-equal predicate for a LocalTime column.
static FilterPredicate	gtEq(String column, UUID value)	Creates a greater-than-or-equal predicate for a UUID column.
static FilterPredicate	in(String column, int... values)
static FilterPredicate	in(String column, long... values)
static FilterPredicate	inStrings(String column, String... values)
static FilterPredicate	isNotNull(String column)	Creates a predicate that matches rows where the given column is not null.
static FilterPredicate	isNull(String column)	Creates a predicate that matches rows where the given column is null.
static FilterPredicate	lt(String column, double value)
static FilterPredicate	lt(String column, float value)
static FilterPredicate	lt(String column, int value)
static FilterPredicate	lt(String column, long value)
static FilterPredicate	lt(String column, String value)
static FilterPredicate	lt(String column, BigDecimal value)	Creates a less-than predicate for a BigDecimal column.
static FilterPredicate	lt(String column, Instant value)	Creates a less-than predicate for an Instant column.
static FilterPredicate	lt(String column, LocalDate value)	Creates a less-than predicate for a LocalDate column.
static FilterPredicate	lt(String column, LocalTime value)	Creates a less-than predicate for a LocalTime column.
static FilterPredicate	lt(String column, UUID value)	Creates a less-than predicate for a UUID column.
static FilterPredicate	ltEq(String column, double value)
static FilterPredicate	ltEq(String column, float value)
static FilterPredicate	ltEq(String column, int value)
static FilterPredicate	ltEq(String column, long value)
static FilterPredicate	ltEq(String column, String value)
static FilterPredicate	ltEq(String column, BigDecimal value)	Creates a less-than-or-equal predicate for a BigDecimal column.
static FilterPredicate	ltEq(String column, Instant value)	Creates a less-than-or-equal predicate for an Instant column.
static FilterPredicate	ltEq(String column, LocalDate value)	Creates a less-than-or-equal predicate for a LocalDate column.
static FilterPredicate	ltEq(String column, LocalTime value)	Creates a less-than-or-equal predicate for a LocalTime column.
static FilterPredicate	ltEq(String column, UUID value)	Creates a less-than-or-equal predicate for a UUID column.
static FilterPredicate	not(FilterPredicate filter)
static FilterPredicate	notEq(String column, boolean value)
static FilterPredicate	notEq(String column, double value)
static FilterPredicate	notEq(String column, float value)
static FilterPredicate	notEq(String column, int value)
static FilterPredicate	notEq(String column, long value)
static FilterPredicate	notEq(String column, String value)
static FilterPredicate	notEq(String column, BigDecimal value)	Creates a not-equals predicate for a BigDecimal column.
static FilterPredicate	notEq(String column, Instant value)	Creates a not-equals predicate for an Instant column.
static FilterPredicate	notEq(String column, LocalDate value)	Creates a not-equals predicate for a LocalDate column.
static FilterPredicate	notEq(String column, LocalTime value)	Creates a not-equals predicate for a LocalTime column.
static FilterPredicate	notEq(String column, UUID value)	Creates a not-equals predicate for a UUID column.
static FilterPredicate	or(FilterPredicate... filters)
static FilterPredicate	or(FilterPredicate left, FilterPredicate right)

Method Details

eq

static FilterPredicate eq(String column,
 int value)

notEq

static FilterPredicate notEq(String column,
 int value)

lt

static FilterPredicate lt(String column,
 int value)

ltEq

static FilterPredicate ltEq(String column,
 int value)

gt

static FilterPredicate gt(String column,
 int value)

gtEq

static FilterPredicate gtEq(String column,
 int value)

eq

static FilterPredicate eq(String column,
 long value)

notEq

static FilterPredicate notEq(String column,
 long value)

lt

static FilterPredicate lt(String column,
 long value)

ltEq

static FilterPredicate ltEq(String column,
 long value)

gt

static FilterPredicate gt(String column,
 long value)

gtEq

static FilterPredicate gtEq(String column,
 long value)

eq

static FilterPredicate eq(String column,
 float value)

notEq

static FilterPredicate notEq(String column,
 float value)

lt

static FilterPredicate lt(String column,
 float value)

ltEq

static FilterPredicate ltEq(String column,
 float value)

gt

static FilterPredicate gt(String column,
 float value)

gtEq

static FilterPredicate gtEq(String column,
 float value)

eq

static FilterPredicate eq(String column,
 double value)

notEq

static FilterPredicate notEq(String column,
 double value)

lt

static FilterPredicate lt(String column,
 double value)

ltEq

static FilterPredicate ltEq(String column,
 double value)

gt

static FilterPredicate gt(String column,
 double value)

gtEq

static FilterPredicate gtEq(String column,
 double value)

eq

static FilterPredicate eq(String column,
 boolean value)

notEq

static FilterPredicate notEq(String column,
 boolean value)

eq

static FilterPredicate eq(String column,
 String value)

notEq

static FilterPredicate notEq(String column,
 String value)

lt

static FilterPredicate lt(String column,
 String value)

ltEq

static FilterPredicate ltEq(String column,
 String value)

gt

static FilterPredicate gt(String column,
 String value)

gtEq

static FilterPredicate gtEq(String column,
 String value)

in

static FilterPredicate in(String column,
 int... values)

in

static FilterPredicate in(String column,
 long... values)

inStrings

static FilterPredicate inStrings(String column,
 String... values)

eq

static FilterPredicate eq(String column,
 LocalDate value)

Creates an equals predicate for a LocalDate column (Parquet DATE logical type). The date is converted to days since the Unix epoch at evaluation time.

notEq

static FilterPredicate notEq(String column,
 LocalDate value)

Creates a not-equals predicate for a LocalDate column.

lt

static FilterPredicate lt(String column,
 LocalDate value)

Creates a less-than predicate for a LocalDate column.

ltEq

static FilterPredicate ltEq(String column,
 LocalDate value)

Creates a less-than-or-equal predicate for a LocalDate column.

gt

static FilterPredicate gt(String column,
 LocalDate value)

Creates a greater-than predicate for a LocalDate column.

gtEq

static FilterPredicate gtEq(String column,
 LocalDate value)

Creates a greater-than-or-equal predicate for a LocalDate column.

eq

static FilterPredicate eq(String column,
 Instant value)

Creates an equals predicate for an Instant column (Parquet TIMESTAMP logical type). The column's time unit is determined from the schema at evaluation time.

notEq

static FilterPredicate notEq(String column,
 Instant value)

Creates a not-equals predicate for an Instant column.

lt

static FilterPredicate lt(String column,
 Instant value)

Creates a less-than predicate for an Instant column.

ltEq

static FilterPredicate ltEq(String column,
 Instant value)

Creates a less-than-or-equal predicate for an Instant column.

gt

static FilterPredicate gt(String column,
 Instant value)

Creates a greater-than predicate for an Instant column.

gtEq

static FilterPredicate gtEq(String column,
 Instant value)

Creates a greater-than-or-equal predicate for an Instant column.

eq

static FilterPredicate eq(String column,
 LocalTime value)

Creates an equals predicate for a LocalTime column (Parquet TIME logical type). The column's time unit is determined from the schema at evaluation time.

notEq

static FilterPredicate notEq(String column,
 LocalTime value)

Creates a not-equals predicate for a LocalTime column.

lt

static FilterPredicate lt(String column,
 LocalTime value)

Creates a less-than predicate for a LocalTime column.

ltEq

static FilterPredicate ltEq(String column,
 LocalTime value)

Creates a less-than-or-equal predicate for a LocalTime column.

gt

static FilterPredicate gt(String column,
 LocalTime value)

Creates a greater-than predicate for a LocalTime column.

gtEq

static FilterPredicate gtEq(String column,
 LocalTime value)

Creates a greater-than-or-equal predicate for a LocalTime column.

eq

static FilterPredicate eq(String column,
 BigDecimal value)

Creates an equals predicate for a BigDecimal column (Parquet DECIMAL logical type). The column's scale, precision, and physical type are determined from the schema at evaluation time.

notEq

static FilterPredicate notEq(String column,
 BigDecimal value)

Creates a not-equals predicate for a BigDecimal column.

lt

static FilterPredicate lt(String column,
 BigDecimal value)

Creates a less-than predicate for a BigDecimal column.

ltEq

static FilterPredicate ltEq(String column,
 BigDecimal value)

Creates a less-than-or-equal predicate for a BigDecimal column.

gt

static FilterPredicate gt(String column,
 BigDecimal value)

Creates a greater-than predicate for a BigDecimal column.

gtEq

static FilterPredicate gtEq(String column,
 BigDecimal value)

Creates a greater-than-or-equal predicate for a BigDecimal column.

eq

static FilterPredicate eq(String column,
 UUID value)

Creates an equals predicate for a UUID column (Parquet UUID logical type). The UUID is encoded as a 16-byte big-endian FIXED_LEN_BYTE_ARRAY.

notEq

static FilterPredicate notEq(String column,
 UUID value)

Creates a not-equals predicate for a UUID column.

lt

static FilterPredicate lt(String column,
 UUID value)

Creates a less-than predicate for a UUID column.

ltEq

static FilterPredicate ltEq(String column,
 UUID value)

Creates a less-than-or-equal predicate for a UUID column.

gt

static FilterPredicate gt(String column,
 UUID value)

Creates a greater-than predicate for a UUID column.

gtEq

static FilterPredicate gtEq(String column,
 UUID value)

Creates a greater-than-or-equal predicate for a UUID column.

isNull

static FilterPredicate isNull(String column)

Creates a predicate that matches rows where the given column is null.

isNotNull

static FilterPredicate isNotNull(String column)

Creates a predicate that matches rows where the given column is not null.

and

static FilterPredicate and(FilterPredicate left,
 FilterPredicate right)

and

static FilterPredicate and(FilterPredicate... filters)

or

static FilterPredicate or(FilterPredicate left,
 FilterPredicate right)

or

static FilterPredicate or(FilterPredicate... filters)

not

static FilterPredicate not(FilterPredicate filter)