io.druid.query.filter

Class RegexDimFilter

java.lang.Object

io.druid.query.filter.RegexDimFilter

All Implemented Interfaces:

Cacheable, DimFilter

public class RegexDimFilter
extends Object
implements DimFilter

Constructor Summary

Constructors

Constructor and Description
RegexDimFilter(String dimension, String pattern, ExtractionFn extractionFn)

Method Summary

Modifier and Type	Method and 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()
String	getPattern()
int	hashCode()
DimFilter	optimize()
Filter	toFilter() Returns a Filter that implements this DimFilter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexDimFilter

public RegexDimFilter(String dimension,
                      String pattern,
                      ExtractionFn extractionFn)

Method Detail

getDimension

public String getDimension()

getPattern

public String getPattern()

getExtractionFn

public ExtractionFn getExtractionFn()

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()

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.

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