Package io.deephaven.engine.table.impl.select

Class AbstractRangeFilter

java.lang.Object

io.deephaven.engine.table.impl.select.WhereFilterImpl

io.deephaven.engine.table.impl.select.AbstractRangeFilter

All Implemented Interfaces:

ConcurrencyControl<Filter>, Expression, Filter, ExposesChunkFilter, WhereFilter, Serializable

Direct Known Subclasses:

ByteRangeFilter, CharRangeFilter, ComparableRangeFilter, DoubleRangeFilter, FloatRangeFilter, IntRangeFilter, LongRangeFilter, ShortRangeFilter, SingleSidedComparableRangeFilter

public abstract class AbstractRangeFilter
extends WhereFilterImpl
implements ExposesChunkFilter

A filter that determines if a column value is between an upper and lower bound (which each may either be inclusive or exclusive).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.engine.table.impl.select.WhereFilter

WhereFilter.PreviousFilteringNotSupported, WhereFilter.RecomputeListener, WhereFilter.Visitor<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	columnName
protected final boolean	lowerInclusive
protected final boolean	upperInclusive

Fields inherited from interface io.deephaven.engine.table.impl.select.WhereFilter

ZERO_LENGTH_WHERE_FILTER_ARRAY

Method Summary

Modifier and Type	Method	Description
Optional<ChunkFilter>	chunkFilter()	Retrieve the underlying chunk filter for this filter if available.
@NotNull WritableRowSet	filter(@NotNull RowSet selection, @NotNull RowSet fullSet, @NotNull Table table, boolean usePrev)	Filter selection to only matching rows.
List<String>	getColumnArrays()	Get the array columns required by this select filter.
List<String>	getColumns()	Get the columns required by this select filter.
final boolean	isLowerInclusive()
boolean	isSimpleFilter()
final boolean	isUpperInclusive()
static WhereFilter	makeBigDecimalRange(String columnName, String val)
void	setRecomputeListener(WhereFilter.RecomputeListener listener)	Set the WhereFilter.RecomputeListener that should be notified if results based on this WhereFilter must be recomputed.

Methods inherited from class io.deephaven.engine.table.impl.select.WhereFilterImpl

isAutomatedFilter, setAutomatedFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.table.impl.select.WhereFilter

beginOperation, canMemoize, copy, filter, filterInverse, hasVirtualRowVariables, init, init, invert, isRefreshing, permitParallelization, validateSafeForRefresh, walk, walk, walk, withDeclaredBarriers, withRespectedBarriers, withSerial

Field Details

columnName

protected final String columnName

upperInclusive

protected final boolean upperInclusive

lowerInclusive

protected final boolean lowerInclusive

Method Details

isUpperInclusive

public final boolean isUpperInclusive()

isLowerInclusive

public final boolean isLowerInclusive()

chunkFilter

public Optional<ChunkFilter> chunkFilter()

Description copied from interface: ExposesChunkFilter

Retrieve the underlying chunk filter for this filter if available.

Specified by:

chunkFilter in interface ExposesChunkFilter

Returns:

If available, returns the underlying chunk filter. Otherwise returns Optional.empty().

makeBigDecimalRange

public static WhereFilter makeBigDecimalRange(String columnName,
 String val)

getColumns

public List<String> getColumns()

Description copied from interface: WhereFilter

Get the columns required by this select filter.

This filter must already be initialized before calling this method.

Specified by:

getColumns in interface WhereFilter

Returns:

the columns used as input by this select filter.

getColumnArrays

public List<String> getColumnArrays()

Description copied from interface: WhereFilter

Get the array columns required by this select filter.

This filter must already be initialized before calling this method.

Specified by:

getColumnArrays in interface WhereFilter

Returns:

the columns used as array input by this select filter.

filter

@NotNull
public @NotNull WritableRowSet filter(@NotNull
 @NotNull RowSet selection,
 @NotNull
 @NotNull RowSet fullSet,
 @NotNull
 @NotNull Table table,
 boolean usePrev)

Description copied from interface: WhereFilter

Filter selection to only matching rows.

Specified by:

filter in interface WhereFilter

Parameters:

selection - the indices that should be filtered. The selection must be a subset of fullSet, and may include rows that the engine determines need not be evaluated to produce the result. Implementations may not mutate or close selection.

fullSet - the complete RowSet of the table to filter. The fullSet is used for calculating variables like "i" or "ii". Implementations may not mutate or close fullSet.

table - the table to filter

usePrev - true if previous values should be used. Implementing previous value filtering is optional, and a WhereFilter.PreviousFilteringNotSupported exception may be thrown. If a PreviousFiltering exception is thrown, then the caller must acquire the PeriodicUpdateGraph lock.

Returns:

The subset of selection accepted by this filter; ownership passes to the caller

isSimpleFilter

public boolean isSimpleFilter()

Specified by:

isSimpleFilter in interface WhereFilter

Returns:

true if this is a filter that does not require any code execution, but rather is handled entirely within the database engine.

setRecomputeListener

public void setRecomputeListener(WhereFilter.RecomputeListener listener)

Description copied from interface: WhereFilter

Set the WhereFilter.RecomputeListener that should be notified if results based on this WhereFilter must be recomputed.

Specified by:

setRecomputeListener in interface WhereFilter

Parameters:

listener - The WhereFilter.RecomputeListener to notify