Package org.apache.druid.query.filter

Class SelectorDimFilter

java.lang.Object

org.apache.druid.query.filter.AbstractOptimizableDimFilter

org.apache.druid.query.filter.SelectorDimFilter

All Implemented Interfaces:

Cacheable, DimFilter

public class SelectorDimFilter
extends AbstractOptimizableDimFilter
implements DimFilter

Recommended to use EqualityFilter or NullFilter instead

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.druid.query.filter.DimFilter

DimFilter.DimFilterToStringBuilder

Constructor Summary

Constructors

Constructor	Description
SelectorDimFilter(String dimension, String value, ExtractionFn extractionFn)
SelectorDimFilter(String dimension, String value, ExtractionFn extractionFn, FilterTuning filterTuning)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
byte[]	getCacheKey()	Get a byte array used as a cache key.
String	getDimension()
com.google.common.collect.RangeSet<String>	getDimensionRangeSet(String dimension)	Returns a RangeSet that represents the possible range of the input dimension for this DimFilter.This is applicable to filters that use dimensions such as select, in, bound, and logical filters such as and, or, not.
ExtractionFn	getExtractionFn()
FilterTuning	getFilterTuning()
Set<String>	getRequiredColumns()
String	getValue()	Value to filter against.
int	hashCode()
DimFilter	optimize(boolean mayIncludeUnknown)	Returns an optimized version of this filter.
Filter	toFilter()	Returns a Filter that implements this DimFilter.
String	toString()

Methods inherited from class org.apache.druid.query.filter.AbstractOptimizableDimFilter

toOptimizedFilter

Methods inherited from class java.lang.Object

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

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

toOptimizedFilter

Constructor Detail

SelectorDimFilter

public SelectorDimFilter(String dimension,
                         String value,
                         @Nullable
                         ExtractionFn extractionFn,
                         @Nullable
                         FilterTuning filterTuning)

SelectorDimFilter

public SelectorDimFilter(String dimension,
                         String value,
                         @Nullable
                         ExtractionFn extractionFn)

Method Detail

getCacheKey

public byte[] getCacheKey()

Description copied from interface: Cacheable

Get a byte array used as a cache key.

Specified by:

getCacheKey in interface Cacheable

Returns:

a cache key

optimize

public DimFilter optimize(boolean mayIncludeUnknown)

Description copied from interface: DimFilter

Returns an optimized version of this filter.

Specified by:

optimize in interface DimFilter

Overrides:

optimize in class AbstractOptimizableDimFilter

Parameters:

mayIncludeUnknown - whether the optimized filter may need to operate in "includeUnknown" mode. See NullHandling.useThreeValueLogic().

toFilter

public Filter toFilter()

Description copied from interface: DimFilter

Returns a Filter that implements this DimFilter. This does not generally involve optimizing the DimFilter, so it does make sense to optimize first and then call toFilter on the resulting DimFilter.

Specified by:

toFilter in interface DimFilter

Returns:

a Filter that implements this DimFilter, or null if this DimFilter is a no-op.

getDimension

public String getDimension()

getValue

@Nullable
public String getValue()

Value to filter against. If null, then the meaning is `is null`.

getExtractionFn

@Nullable
public ExtractionFn getExtractionFn()

getFilterTuning

@Nullable
public FilterTuning getFilterTuning()

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

getDimensionRangeSet

public com.google.common.collect.RangeSet<String> getDimensionRangeSet(String dimension)

Description copied from interface: DimFilter

Returns a RangeSet that represents the possible range of the input dimension for this DimFilter.This is applicable to filters that use dimensions such as select, in, bound, and logical filters such as and, or, not. Null represents that the range cannot be determined, and will be returned for filters such as javascript and regex where there's no easy way to determine the filtered range. It is treated the same way as an all range in most cases, however there are some subtle difference at logical filters such as not filter, where complement of all is nothing while complement of null is still null.

Specified by:

getDimensionRangeSet in interface DimFilter

Parameters:

dimension - name of the dimension to get range for

Returns:

a RangeSet that represent the possible range of the input dimension, or null if it is not possible to determine for this DimFilter.

getRequiredColumns

public Set<String> getRequiredColumns()

Specified by:

getRequiredColumns in interface DimFilter

Returns:

a HashSet that represents all columns' name which the DimFilter required to do filter.