TupleDomainFilter (presto-common 0.272 API)

All Known Implementing Classes:

TupleDomainFilter.AbstractRange, TupleDomainFilter.AbstractTupleDomainFilter, TupleDomainFilter.AlwaysFalse, TupleDomainFilter.BasePositionalFilter, TupleDomainFilter.BigintMultiRange, TupleDomainFilter.BigintRange, TupleDomainFilter.BigintValuesUsingBitmask, TupleDomainFilter.BigintValuesUsingHashTable, TupleDomainFilter.BooleanValue, TupleDomainFilter.BytesRange, TupleDomainFilter.BytesValues, TupleDomainFilter.BytesValuesExclusive, TupleDomainFilter.DoubleRange, TupleDomainFilter.FloatRange, TupleDomainFilter.IsNotNull, TupleDomainFilter.IsNull, TupleDomainFilter.LongDecimalRange, TupleDomainFilter.MultiRange, TupleDomainFilter.NullsFilter, TupleDomainFilter.PositionalFilter
```
public interface TupleDomainFilter
```
A simple filter (e.g. comparison with literal) that can be applied efficiently while extracting values from an ORC stream.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TupleDomainFilter.AbstractRange`
`static class`	`TupleDomainFilter.AbstractTupleDomainFilter`
`static class`	`TupleDomainFilter.AlwaysFalse`
`static class`	`TupleDomainFilter.BasePositionalFilter`
`static class`	`TupleDomainFilter.BigintMultiRange`
`static class`	`TupleDomainFilter.BigintRange`
`static class`	`TupleDomainFilter.BigintValuesUsingBitmask`
`static class`	`TupleDomainFilter.BigintValuesUsingHashTable`
`static class`	`TupleDomainFilter.BooleanValue`
`static class`	`TupleDomainFilter.BytesRange`
`static class`	`TupleDomainFilter.BytesValues`
`static class`	`TupleDomainFilter.BytesValuesExclusive`
`static class`	`TupleDomainFilter.DoubleRange`
`static class`	`TupleDomainFilter.FloatRange`
`static class`	`TupleDomainFilter.IsNotNull`
`static class`	`TupleDomainFilter.IsNull`
`static class`	`TupleDomainFilter.LongDecimalRange`
`static class`	`TupleDomainFilter.MultiRange`
`static class`	`TupleDomainFilter.NullsFilter`
`static class`	`TupleDomainFilter.PositionalFilter`

Field Summary

Fields
Modifier and Type Field and Description

static TupleDomainFilter ALWAYS_FALSE

static TupleDomainFilter IS_NOT_NULL

static TupleDomainFilter IS_NULL

Fields
Modifier and Type	Field and Description
`static TupleDomainFilter`	`ALWAYS_FALSE`
`static TupleDomainFilter`	`IS_NOT_NULL`
`static TupleDomainFilter`	`IS_NULL`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getPrecedingPositionsToFail()` When a filter applied to a nested column fails, the whole top-level position should fail.
`int`	`getSucceedingPositionsToFail()`
`boolean`	`isDeterministic()` A filter becomes non-deterministic when applies to nested column, e.g.
`boolean`	`isPositionalFilter()`
`boolean`	`testBoolean(boolean value)`
`boolean`	`testBytes(byte[] buffer, int offset, int length)`
`boolean`	`testDecimal(long low, long high)`
`boolean`	`testDouble(double value)`
`boolean`	`testFloat(float value)`
`boolean`	`testLength(int length)` Filters like string equality and IN, as well as conditions on cardinality of lists and maps can be at least partly decided by looking at lengths alone.
`boolean`	`testLong(long value)`
`boolean`	`testNonNull()` Used to apply is [not] null filters to complex types, e.g.
`boolean`	`testNull()`

- Field Detail
  - ALWAYS_FALSE
```
static final TupleDomainFilter ALWAYS_FALSE
```
  - IS_NULL
```
static final TupleDomainFilter IS_NULL
```
  - IS_NOT_NULL
```
static final TupleDomainFilter IS_NOT_NULL
```
- Method Detail
  - isDeterministic
```
boolean isDeterministic()
```
    A filter becomes non-deterministic when applies to nested column, e.g. a[1] > 10 is non-deterministic because > 10 filter applies only to some positions, e.g. first entry in a set of entries that correspond to a single top-level position.
  - testNull
```
boolean testNull()
```
  - testNonNull
```
boolean testNonNull()
```
    Used to apply is [not] null filters to complex types, e.g. a[1] is null AND a[3] is not null, where a is an array(array(T)).
    In these case, the exact values are not known, but it is known whether they are null or not. Furthermore, for some positions only nulls are allowed (a[1] is null), for others only non-nulls (a[3] is not null), and for the rest both are allowed (a[2] and a[N], where N > 3).
  - testLong
```
boolean testLong(long value)
```
  - testDouble
```
boolean testDouble(double value)
```
  - testFloat
```
boolean testFloat(float value)
```
  - testDecimal
```
boolean testDecimal(long low,
                    long high)
```
  - testBoolean
```
boolean testBoolean(boolean value)
```
  - testBytes
```
boolean testBytes(byte[] buffer,
                  int offset,
                  int length)
```
  - testLength
```
boolean testLength(int length)
```
    Filters like string equality and IN, as well as conditions on cardinality of lists and maps can be at least partly decided by looking at lengths alone. If this is false, then no further checks are needed. If true, eventual filters on the data itself need to be evaluated.
  - getPrecedingPositionsToFail
```
int getPrecedingPositionsToFail()
```
    When a filter applied to a nested column fails, the whole top-level position should fail. To enable this functionality, the filter keeps track of the boundaries of top-level positions and allows the caller to find out where the current top-level position started and how far it continues.
    
    Returns:
    
    number of positions from the start of the current top-level position up to the current position (excluding current position)
  - getSucceedingPositionsToFail
```
int getSucceedingPositionsToFail()
```
    Returns:
    
    number of positions remaining until the end of the current top-level position
  - isPositionalFilter
```
boolean isPositionalFilter()
```
    Returns:
    
    true if getPrecedingPositionsToFail or getSucceedingPositionsToFail may return non-zero values

Interface TupleDomainFilter

Nested Class Summary

Field Summary

Method Summary

Field Detail

ALWAYS_FALSE

IS_NULL

IS_NOT_NULL

Method Detail

isDeterministic

testNull

testNonNull

testLong

testDouble

testFloat

testDecimal

testBoolean

testBytes

testLength

getPrecedingPositionsToFail

getSucceedingPositionsToFail

isPositionalFilter