Package io.deephaven.api.filter
Interface Filter
- All Superinterfaces:
Expression
- All Known Subinterfaces:
LiteralFilter
,ReindexingFilter
,WhereFilter
- All Known Implementing Classes:
AbstractConditionFilter
,AbstractRangeFilter
,AutoTuningIncrementalReleaseFilter
,BaseIncrementalReleaseFilter
,ByteRangeFilter
,CharRangeFilter
,ClockFilter
,ComparableRangeFilter
,ComposedFilter
,ConditionFilter
,ConjunctiveFilter
,DisjunctiveFilter
,DoubleRangeFilter
,DownsampledWhereFilter
,DynamicWhereFilter
,FilterAnd
,FilterBase
,FilterComparison
,FilterIn
,FilterIsNull
,FilterNot
,FilterOr
,FilterPattern
,FloatRangeFilter
,Function
,IncrementalReleaseFilter
,InstantRangeFilter
,IntRangeFilter
,LongRangeFilter
,MatchFilter
,Method
,RangeFilter
,RawString
,RollingReleaseFilter
,ShortRangeFilter
,SingleSidedComparableRangeFilter
,SortedClockFilter
,TimeSeriesFilter
,UnsortedClockFilter
,WhereFilterImpl
,WhereFilterLivenessArtifactImpl
,WhereNoneFilter
Represents an evaluate-able filter.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Filter
Creates a filter that evaluates totrue
when all of thefilters
evaluate totrue
, andfalse
when any of thefilters
evaluates tofalse
.static Filter
and
(Collection<? extends Filter> filters) Creates a filter that evaluates totrue
when all of thefilters
evaluate totrue
, andfalse
when any of thefilters
evaluates tofalse
.static Collection<Filter>
extractAnds
(Filter filter) Performs a non-recursive "and-extraction" againstfilter
.static Collection<? extends Filter>
static Collection<? extends Filter>
from
(Collection<String> expressions) invert()
The logical inversion ofthis
.static FilterComparison
isFalse
(Expression expression) Creates an is-false-filter.static FilterNot<FilterIsNull>
isNotNull
(Expression expression) Creates an is-not-null-filter.static FilterIsNull
isNull
(Expression expression) Creates an is-null-filter.static FilterComparison
isTrue
(Expression expression) Creates an is-true-filter.not
(F filter) Creates anot-filter
fromfilter
.static LiteralFilter
ofFalse()
Creates an always-false-filter.static LiteralFilter
ofTrue()
Creates an always-true-filter.static Filter
Creates a filter that evaluates totrue
when any offilters
evaluates totrue
, andfalse
when none of thefilters
evaluates totrue
.static Filter
or
(Collection<? extends Filter> filters) Creates a filter that evaluates totrue
when any offilters
evaluates totrue
, andfalse
when none of thefilters
evaluates totrue
.<T> T
walk
(Filter.Visitor<T> visitor) Methods inherited from interface io.deephaven.api.expression.Expression
walk
-
Method Details
-
from
-
from
-
ofTrue
Creates an always-true-filter.Equivalent to
Literal.of(true)
.- Returns:
- the always-true-filter
-
ofFalse
Creates an always-false-filter.Equivalent to
Literal.of(false)
.- Returns:
- the always-false-filter
-
isNull
Creates an is-null-filter.- Parameters:
expression
- the expression- Returns:
- the is-null-filter
-
isNotNull
Creates an is-not-null-filter.Equivalent to
not(isNull(expression))
.- Parameters:
expression
- the expression- Returns:
- the is-not-null-filter
-
isTrue
Creates an is-true-filter.Equivalent to
FilterComparison.eq(expression, ofTrue())
.- Parameters:
expression
- the expression- Returns:
- the equals-true-filter
-
isFalse
Creates an is-false-filter.Equivalent to
FilterComparison.eq(expression, ofFalse())
.- Parameters:
expression
- the expression- Returns:
-
not
Creates anot-filter
fromfilter
. Callers should typically preferinvert()
, unless the "not" context needs to be preserved.- Type Parameters:
F
- the type of filter- Parameters:
filter
- the filter- Returns:
- the not-filter
-
or
Creates a filter that evaluates totrue
when any offilters
evaluates totrue
, andfalse
when none of thefilters
evaluates totrue
. This implies thatofFalse()
is returned whenfilters
is empty.- Parameters:
filters
- the filters- Returns:
- the filter
-
or
Creates a filter that evaluates totrue
when any offilters
evaluates totrue
, andfalse
when none of thefilters
evaluates totrue
. This implies thatofFalse()
is returned whenfilters
is empty.- Parameters:
filters
- the filters- Returns:
- the filter
-
and
Creates a filter that evaluates totrue
when all of thefilters
evaluate totrue
, andfalse
when any of thefilters
evaluates tofalse
. This implies thatofTrue()
is returned whenfilters
is empty.- Parameters:
filters
- the filters- Returns:
- the filter
-
and
Creates a filter that evaluates totrue
when all of thefilters
evaluate totrue
, andfalse
when any of thefilters
evaluates tofalse
. This implies thatofTrue()
is returned whenfilters
is empty.- Parameters:
filters
- the filters- Returns:
- the filter
-
extractAnds
Performs a non-recursive "and-extraction" againstfilter
. Iffilter
is aFilterAnd
,FilterAnd.filters()
will be returned. Iffilter
isofTrue()
, an empty list will be returned. Otherwise, a singleton list offilter
will be returned.- Parameters:
filter
- the filter- Returns:
- the and-extracted filter
-
invert
Filter invert()The logical inversion ofthis
. While logically equivalent toFilter.not(this)
, implementations of this method will return more specifically typed inversions where applicable.- Returns:
- the inverse filter
- See Also:
-
walk
-