Package org.apache.druid.segment.filter

Class OrFilter

java.lang.Object

org.apache.druid.segment.filter.OrFilter

All Implemented Interfaces:

BooleanFilter, Filter

public class OrFilter
extends Object
implements BooleanFilter

Logical OR filter operation

Constructor Summary

Constructors

Constructor	Description
OrFilter(LinkedHashSet<Filter> filters)
OrFilter(List<Filter> filters)

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)
BitmapColumnIndex	getBitmapColumnIndex(BitmapFactory bitmapFactory, List<FilterBundle.Builder> childBuilders)	Specialized alternative to Filter.getBitmapColumnIndex(ColumnIndexSelector) to allow reuse any precomputed 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.
LinkedHashSet<Filter>	getFilters()	Returns the child filters for this filter.
int	hashCode()
<T> FilterBundle	makeFilterBundle(FilterBundle.Builder filterBundleBuilder, BitmapResultFactory<T> bitmapResultFactory, int applyRowCount, int totalRowCount, boolean includeUnknown)	Compute indexes and build a container FilterBundle to be used during Cursor or VectorCursor creation, combining the computed outputs of Filter.getBitmapColumnIndex(ColumnIndexSelector) as well as references to Filter.makeMatcher(ColumnSelectorFactory) and Filter.makeVectorMatcher(VectorColumnSelectorFactory).
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.BooleanFilter

getRequiredColumns

Constructor Details

OrFilter

public OrFilter(LinkedHashSet<Filter> filters)

OrFilter

public OrFilter(List<Filter> filters)

Method Details

makeFilterBundle

public <T> FilterBundle makeFilterBundle(FilterBundle.Builder filterBundleBuilder,
 BitmapResultFactory<T> bitmapResultFactory,
 int applyRowCount,
 int totalRowCount,
 boolean includeUnknown)

Description copied from interface: Filter

Compute indexes and build a container FilterBundle to be used during Cursor or VectorCursor creation, combining the computed outputs of Filter.getBitmapColumnIndex(ColumnIndexSelector) as well as references to Filter.makeMatcher(ColumnSelectorFactory) and Filter.makeVectorMatcher(VectorColumnSelectorFactory).

Filters populating the FilterBundle container should only set the values which MUST be evaluated by the cursor. If both are set, the cursor will effectively perform a logical AND to combine them. See FilterBundle for additional details.

Specified by:

makeFilterBundle in interface Filter

Type Parameters:

T - type of BitmapResultFactory results, ImmutableBitmap by default

Parameters:

filterBundleBuilder - contains BitmapColumnIndex and ColumnIndexSelector, and some additional info needed.

bitmapResultFactory - wrapper for ImmutableBitmap operations to tie into QueryMetrics and build the output indexes

applyRowCount - upper bound on number of rows this filter would be applied to, after removing rows short-circuited by prior bundle operations. For example, given "x AND y", if "x" is resolved using an index, then "y" will receive the number of rows that matched the filter "x". As another example, given "x OR y", if "x" is resolved using an index, then "y" will receive the number of rows that did *not* match the filter "x".

totalRowCount - total number of rows to be scanned if no indexes are applied

includeUnknown - mapping for Druid native two state logic system into SQL three-state logic system. If set to true, bitmaps returned by this method should include true bits for any rows where the matching result is 'unknown', such as from the input being null valued.

Returns:

FilterBundle containing any indexes and/or matchers that are needed to build a cursor

getBitmapColumnIndex

@Nullable
public BitmapColumnIndex getBitmapColumnIndex(BitmapFactory bitmapFactory,
 List<FilterBundle.Builder> childBuilders)

Description copied from interface: BooleanFilter

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

Specified by:

getBitmapColumnIndex in interface BooleanFilter

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

getFilters

public LinkedHashSet<Filter> getFilters()

Description copied from interface: BooleanFilter

Returns the child filters for this filter. This is a LinkedHashSet because we don't want duplicates, but the order is also important in some cases (such as when filters are provided in an order that encourages short-circuiting.)

Specified by:

getFilters in interface BooleanFilter

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