Package org.apache.druid.segment.filter

Class IsBooleanFilter

java.lang.Object

org.apache.druid.segment.filter.IsBooleanFilter

All Implemented Interfaces:

BooleanUnaryFilter, Filter

public class IsBooleanFilter
extends Object
implements BooleanUnaryFilter

SQL three-value logic wrapper for some child Filter to implement '{filter} IS TRUE' and '{filter} IS FALSE'. Primarily useful when living beneath a NotFilter because this filter purposely ignores the value of includeUnknown and so always correctly only returns values that definitely match or do not match the filter to produce correct results for '{filter} IS NOT TRUE' and '{filter} IS NOT FALSE'. This filter is a relatively thin wrapper, so should be relatively harmless if used without a 'NOT' filter.

See Also:

• IsBooleanDimFilter
• IsTrueDimFilter
• IsFalseDimFilter

Constructor Summary

Constructors

Constructor	Description
IsBooleanFilter(Filter baseFilter, boolean isTrue)

Method Summary

Modifier and Type	Method	Description
boolean	canVectorizeMatcher(ColumnInspector inspector)	Returns true if this filter can produce a vectorized matcher from its "makeVectorMatcher" method.
boolean	equals(Object o)
Filter	getBaseFilter()
BitmapColumnIndex	getBitmapColumnIndex(int numRows, FilterBundle.Builder baseBuilder)	Specialized alternative to Filter.getBitmapColumnIndex(ColumnIndexSelector) to allow reuse of BitmapColumnIndex created as part of a FilterBundle.Builder
BitmapColumnIndex	getBitmapColumnIndex(ColumnIndexSelector selector)	Returns a BitmapColumnIndex if this filter supports using a bitmap index for filtering for the given input ColumnIndexSelector.
Set<String>	getRequiredColumns()	Set of columns used by a filter.
int	hashCode()
boolean	isTrue()
ValueMatcher	makeMatcher(ColumnSelectorFactory factory)	Get a ValueMatcher that applies this filter to row values.
VectorValueMatcher	makeVectorMatcher(VectorColumnSelectorFactory factory)	Get a VectorValueMatcher that applies this filter to row vectors.
Filter	rewriteRequiredColumns(Map<String,String> columnRewrites)	Return a copy of this filter that is identical to the this filter except that it operates on different columns, based on a renaming map where the key is the column to be renamed in the filter, and the value is the new column name.
boolean	supportsRequiredColumnRewrite()	Returns true is this filter is able to return a copy of this filter that is identical to this filter except that it operates on different columns, based on a renaming map.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.druid.query.filter.Filter

makeFilterBundle

Constructor Details

IsBooleanFilter

public IsBooleanFilter(Filter baseFilter,
 boolean isTrue)

Method Details

isTrue

public boolean isTrue()

getBaseFilter

public Filter getBaseFilter()

Specified by:

getBaseFilter in interface BooleanUnaryFilter

getBitmapColumnIndex

@Nullable
public BitmapColumnIndex getBitmapColumnIndex(int numRows,
 FilterBundle.Builder baseBuilder)

Description copied from interface: BooleanUnaryFilter

Specialized alternative to Filter.getBitmapColumnIndex(ColumnIndexSelector) to allow reuse of BitmapColumnIndex created as part of a FilterBundle.Builder

Specified by:

getBitmapColumnIndex in interface BooleanUnaryFilter

getBitmapColumnIndex

@Nullable
public BitmapColumnIndex getBitmapColumnIndex(ColumnIndexSelector selector)

Description copied from interface: Filter

Returns a BitmapColumnIndex if this filter supports using a bitmap index for filtering for the given input ColumnIndexSelector. The BitmapColumnIndex can be used to compute into a bitmap indicating rows that match this filter result BitmapColumnIndex.computeBitmapResult(BitmapResultFactory, boolean), or examine details about the index prior to computing it, via BitmapColumnIndex.getIndexCapabilities().

Specified by:

getBitmapColumnIndex in interface Filter

Parameters:

selector - Object used to create BitmapColumnIndex

Returns:

BitmapColumnIndex that can build ImmutableBitmap of matched row numbers

makeMatcher

public ValueMatcher makeMatcher(ColumnSelectorFactory factory)

Description copied from interface: Filter

Get a ValueMatcher that applies this filter to row values.

Specified by:

makeMatcher in interface Filter

Parameters:

factory - Object used to create ValueMatchers

Returns:

ValueMatcher that applies this filter to row values.

makeVectorMatcher

public VectorValueMatcher makeVectorMatcher(VectorColumnSelectorFactory factory)

Description copied from interface: Filter

Get a VectorValueMatcher that applies this filter to row vectors.

Specified by:

makeVectorMatcher in interface Filter

Parameters:

factory - Object used to create ValueMatchers

Returns:

VectorValueMatcher that applies this filter to row vectors.

canVectorizeMatcher

public boolean canVectorizeMatcher(ColumnInspector inspector)

Description copied from interface: Filter

Returns true if this filter can produce a vectorized matcher from its "makeVectorMatcher" method.

Specified by:

canVectorizeMatcher in interface Filter

Parameters:

inspector - Supplies type information for the selectors this filter will match against

getRequiredColumns

public Set<String> getRequiredColumns()

Description copied from interface: Filter

Set of columns used by a filter.

Specified by:

getRequiredColumns in interface Filter

supportsRequiredColumnRewrite

public boolean supportsRequiredColumnRewrite()

Description copied from interface: Filter

Returns true is this filter is able to return a copy of this filter that is identical to this filter except that it operates on different columns, based on a renaming map.

Specified by:

supportsRequiredColumnRewrite in interface Filter

rewriteRequiredColumns

public Filter rewriteRequiredColumns(Map<String,String> columnRewrites)

Description copied from interface: Filter

Return a copy of this filter that is identical to the this filter except that it operates on different columns, based on a renaming map where the key is the column to be renamed in the filter, and the value is the new column name.

For example, if I have a filter (A = hello), and I have a renaming map (A -> B), this should return the filter (B = hello)

Specified by:

rewriteRequiredColumns in interface Filter

Parameters:

columnRewrites - Column rewrite map

Returns:

Copy of this filter that operates on new columns based on the rewrite map

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object