org.apache.druid.query.filter

Class JavaScriptDimFilter

java.lang.Object

org.apache.druid.query.filter.AbstractOptimizableDimFilter

org.apache.druid.query.filter.JavaScriptDimFilter

All Implemented Interfaces:

Cacheable, DimFilter

public class JavaScriptDimFilter
extends AbstractOptimizableDimFilter
implements DimFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaScriptDimFilter.JavaScriptPredicateFactory

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

DimFilter.DimFilterToStringBuilder

Constructor Summary

Constructors

Constructor and Description
JavaScriptDimFilter(String dimension, String function, ExtractionFn extractionFn, FilterTuning filterTuning, JavaScriptConfig config)
JavaScriptDimFilter(String dimension, String function, ExtractionFn extractionFn, JavaScriptConfig config)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
byte[]	getCacheKey()
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()
String	getFunction()
Set<String>	getRequiredColumns()
int	hashCode()
DimFilter	optimize()
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

JavaScriptDimFilter

public JavaScriptDimFilter(String dimension,
                           String function,
                           @Nullable
                           ExtractionFn extractionFn,
                           @Nullable
                           FilterTuning filterTuning,
                           JavaScriptConfig config)

JavaScriptDimFilter

public JavaScriptDimFilter(String dimension,
                           String function,
                           @Nullable
                           ExtractionFn extractionFn,
                           JavaScriptConfig config)

Method Detail

getDimension

public String getDimension()

getFunction

public String getFunction()

getExtractionFn

@Nullable
public ExtractionFn getExtractionFn()

getFilterTuning

@Nullable
public FilterTuning getFilterTuning()

getCacheKey

public byte[] getCacheKey()

Specified by:

getCacheKey in interface Cacheable

optimize

public DimFilter optimize()

Specified by:

optimize in interface DimFilter

Returns:

Returns an optimized filter. returning the same filter can be a straightforward default implementation.

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.

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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object