Package org.apache.druid.segment.filter

Class DimensionPredicateFilter

java.lang.Object

org.apache.druid.segment.filter.DimensionPredicateFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

RegexFilter, SearchQueryFilter

public class DimensionPredicateFilter
extends Object
implements Filter

Field Summary

Fields

Modifier and Type	Field	Description
protected String	basePredicateString
protected String	dimension
protected ExtractionFn	extractionFn
protected FilterTuning	filterTuning
protected DruidPredicateFactory	predicateFactory

Constructor Summary

Constructors

Constructor	Description
DimensionPredicateFilter(String dimension, DruidPredicateFactory predicateFactory, ExtractionFn extractionFn)
DimensionPredicateFilter(String dimension, DruidPredicateFactory predicateFactory, ExtractionFn extractionFn, FilterTuning filterTuning)

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(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()
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.
boolean	supportsSelectivityEstimation(ColumnSelector columnSelector, ColumnIndexSelector indexSelector)	Indicates whether this filter supports selectivity estimation.
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

estimateSelectivity, rewriteRequiredColumns, supportsRequiredColumnRewrite

Field Detail

dimension

protected final String dimension

predicateFactory

protected final DruidPredicateFactory predicateFactory

basePredicateString

protected final String basePredicateString

extractionFn

protected final ExtractionFn extractionFn

filterTuning

protected final FilterTuning filterTuning

Constructor Detail

DimensionPredicateFilter

public DimensionPredicateFilter(String dimension,
                                DruidPredicateFactory predicateFactory,
                                ExtractionFn extractionFn)

DimensionPredicateFilter

public DimensionPredicateFilter(String dimension,
                                DruidPredicateFactory predicateFactory,
                                ExtractionFn extractionFn,
                                FilterTuning filterTuning)

Method Detail

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

supportsSelectivityEstimation

public boolean supportsSelectivityEstimation(ColumnSelector columnSelector,
                                             ColumnIndexSelector indexSelector)

Description copied from interface: Filter

Indicates whether this filter supports selectivity estimation. A filter supports selectivity estimation if it supports bitmap index and the dimension which the filter evaluates does not have multi values.

Specified by:

supportsSelectivityEstimation in interface Filter

Parameters:

columnSelector - Object to check the dimension has multi values.

indexSelector - Object used to retrieve bitmap indexes

Returns:

true if this Filter supports selectivity estimation, false otherwise.

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