com.yahoo.bard.webservice.data.filterbuilders

Class ConjunctionDruidFilterBuilder

java.lang.Object

com.yahoo.bard.webservice.data.filterbuilders.ConjunctionDruidFilterBuilder

All Implemented Interfaces:

DruidFilterBuilder

Direct Known Subclasses:

ConsolidatingDruidFilterBuilder, DefaultDruidFilterBuilder

public abstract class ConjunctionDruidFilterBuilder
extends Object
implements DruidFilterBuilder

A ConjunctionDruidFilterBuilder builds a Druid filter by taking the conjunction of filter clauses, one for each dimension being filtered on.

Constructor Summary

Constructors

Constructor and Description
ConjunctionDruidFilterBuilder()

Method Summary

Modifier and Type	Method and Description
protected abstract Filter	buildDimensionFilter(Dimension dimension, Set<ApiFilter> filters) Take the conjunction of all the filters on a single dimension.
Filter	buildFilters(Map<Dimension,Set<ApiFilter>> filterMap) Combines the filters for a set of dimensions into a single Druid filter.
protected List<Filter>	buildSelectorFilters(Dimension dimension, Set<DimensionRow> rows) Builds a list of Druid selector or extraction filters.
protected Set<DimensionRow>	getFilteredDimensionRows(Dimension dimension, Set<ApiFilter> filters) Resolves a set of ApiFilters into a list of dimension rows that need to be filtered in Druid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConjunctionDruidFilterBuilder

public ConjunctionDruidFilterBuilder()

Method Detail

buildFilters

public Filter buildFilters(Map<Dimension,Set<ApiFilter>> filterMap)
                    throws DimensionRowNotFoundException

Description copied from interface: DruidFilterBuilder

Combines the filters for a set of dimensions into a single Druid filter.

Specified by:

buildFilters in interface DruidFilterBuilder

Parameters:

filterMap - The map of filters per dimension

Returns:

A filter that combines the filters for each of the dimensions, or null if there is no filter

Throws:

DimensionRowNotFoundException - if filtering on a dimension that does not have dimension rows

buildDimensionFilter

protected abstract Filter buildDimensionFilter(Dimension dimension,
                                               Set<ApiFilter> filters)
                                        throws DimensionRowNotFoundException

Take the conjunction of all the filters on a single dimension.

Parameters:

dimension - Dimension for the filters

filters - All filters belonging to that dimension

Returns:

A druid query filter object representing the filtering on a given dimension

Throws:

DimensionRowNotFoundException - if we attempt to filter a dimension without dimension rows

getFilteredDimensionRows

protected Set<DimensionRow> getFilteredDimensionRows(Dimension dimension,
                                                     Set<ApiFilter> filters)
                                              throws DimensionRowNotFoundException

Resolves a set of ApiFilters into a list of dimension rows that need to be filtered in Druid.

Parameters:

dimension - The dimension being filtered

filters - The filters being applied to the dimension

Returns:

A list of dimension rows that Druid needs to filter on

Throws:

DimensionRowNotFoundException - if the filters filter out all dimension rows

buildSelectorFilters

protected List<Filter> buildSelectorFilters(Dimension dimension,
                                            Set<DimensionRow> rows)

Builds a list of Druid selector or extraction filters.

Parameters:

dimension - The dimension to build the list of Druid selector filters from

rows - The set of dimension rows that need selector filters built around

Returns:

a list of Druid selector filters