Package io.deephaven.api.filter

Class FilterPattern

java.lang.Object

io.deephaven.api.filter.FilterBase

io.deephaven.api.filter.FilterPattern

All Implemented Interfaces:

Expression, Filter

@Immutable
public abstract class FilterPattern
extends FilterBase

A filter based on a regular-expression Pattern, compatible with any column types that are compatible with CharSequence.

In the MATCHES case, the logic is equivalent to value != null && (invertPattern() ^ pattern().matcher(value).matches()).

In the FIND case, the logic is equivalent to value != null && (invertPattern() ^ pattern().matcher(value).find()).

This filter will never match null values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterPattern.Builder
static enum	FilterPattern.Mode	The pattern mode

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

Filter.Visitor<T>

Constructor Summary

Constructors

Constructor	Description
FilterPattern()

Method Summary

Modifier and Type	Method	Description
static FilterPattern.Builder	builder()
final boolean	equals(Object obj)
abstract Expression	expression()
final int	hashCode()
final FilterNot<FilterPattern>	invert()	The logical inversion of this.
boolean	invertPattern()
abstract FilterPattern.Mode	mode()
static FilterPattern	of(Expression expression, Pattern pattern, FilterPattern.Mode mode, boolean invertPattern)
abstract Pattern	pattern()
final String	toString()
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FilterPattern

public FilterPattern()

Method Details

builder

public static FilterPattern.Builder builder()

of

public static FilterPattern of(Expression expression,
 Pattern pattern,
 FilterPattern.Mode mode,
 boolean invertPattern)

expression

public abstract Expression expression()

pattern

public abstract Pattern pattern()

mode

public abstract FilterPattern.Mode mode()

invertPattern

@Default
public boolean invertPattern()

invert

public final FilterNot<FilterPattern> 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)

toString

public final String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object