Package io.deephaven.api.filter

Class FilterIn

java.lang.Object

io.deephaven.api.filter.FilterBase

io.deephaven.api.filter.FilterIn

All Implemented Interfaces:

Expression, Filter

@Immutable
public abstract class FilterIn
extends FilterBase

Evaluates to true when expression() is equal to any value in values().

See asComparisons() for the logical equivalent expressed more verbosely.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterIn.Builder

Nested classes/interfaces inherited from interface io.deephaven.api.filter.Filter

Filter.Visitor<T>

Constructor Summary

Constructors

Constructor	Description
FilterIn()

Method Summary

Modifier and Type	Method	Description
final Filter	asComparisons()	Creates the logical equivalent of this as an Filter.or(Collection) with FilterComparison.eq(Expression, Expression) between expression() and each values().
final FilterComparison	asEquals()	Creates the logical equivalent of this as a single FilterComparison.eq(Expression, Expression) between expression() and the only value from values().
static FilterIn.Builder	builder()
abstract Expression	expression()
final FilterNot<FilterIn>	invert()	The logical inversion of this.
static FilterIn	of(Expression expression, Expression... values)
static FilterIn	of(Expression expression, List<Expression> values)
abstract List<Expression>	values()
final <T> T	walk(Filter.Visitor<T> visitor)

Methods inherited from class io.deephaven.api.filter.FilterBase

walk

Methods inherited from class java.lang.Object

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

Constructor Details

FilterIn

public FilterIn()

Method Details

builder

public static FilterIn.Builder builder()

of

public static FilterIn of(Expression expression,
 List<Expression> values)

of

public static FilterIn of(Expression expression,
 Expression... values)

expression

public abstract Expression expression()

values

public abstract List<Expression> values()

invert

public final FilterNot<FilterIn> invert()

Description copied from interface: Filter

The logical inversion of this. While logically equivalent to Filter.not(this), implementations of this method will return more specifically typed inversions where applicable.

Returns:

the inverse filter

See Also:

• Filter.not(Filter)

walk

public final <T> T walk(Filter.Visitor<T> visitor)

asComparisons

public final Filter asComparisons()

Creates the logical equivalent of this as an Filter.or(Collection) with FilterComparison.eq(Expression, Expression) between expression() and each values().

Equivalent to Filter.or(values().stream().map(rhs -> FilterComparison.eq(expression(), rhs)).collect(Collectors.toList())).

Returns:

the filter as comparisons

See Also:

• Filter.or(Collection)
• FilterComparison.eq(Expression, Expression)

asEquals

public final FilterComparison asEquals()

Creates the logical equivalent of this as a single FilterComparison.eq(Expression, Expression) between expression() and the only value from values().

Returns:

the equals-filter

Throws:

IllegalArgumentException - if values().size() != 1