com.yahoo.bard.webservice.web

Interface MetricsFilterSetBuilder

All Known Implementing Classes:

FilteredSketchMetricsHelper, FilteredThetaSketchMetricsHelper

public interface MetricsFilterSetBuilder

An interface containing helper methods to build filtered metrics.

Method Summary

Modifier and Type	Method and Description
Set<Dimension>	gatherFilterDimensions(Filter filter) Helper method that calls gatherFilterDimensions(Filter, Set) by passing in filter and an empty HashSet.
Set<Dimension>	gatherFilterDimensions(Filter filter, Set<Dimension> dimensions) Method to get dimensions from a Filter object.
String	generateMetricName(String filterString) Method to prepare filter string.
Set<FilteredAggregation>	getFilteredAggregation(com.fasterxml.jackson.databind.JsonNode filter, Aggregation aggregation, DimensionDictionary dimensionDictionary, LogicalTable table, DataApiRequest apiRequest) For a given aggregator, this method applies the filter and returns a set of filtered aggregations.
LogicalMetric	getFilteredLogicalMetric(LogicalMetric logicalMetric, com.fasterxml.jackson.databind.JsonNode metricFilterObject, DimensionDictionary dimensionDictionary, LogicalTable table, DataApiRequest apiRequest) Provides filter wrapped logical metric for the given logical metric.
PostAggregation	replacePostAggregation(SketchSetOperationPostAggFunction func, PostAggregation postAggregation, Map<String,List<FilteredAggregation>> filteredAggDictionary) A method to replace postAggs with new postAggs that access the intersection or union of filteredAggregators.
PostAggregation	replacePostAggWithPostAggFromMap(PostAggregation postAggregation, Map<String,Aggregation> oldNameToNewAggregationMapping) Takes a post aggregation and updates its FieldAccessor if its fieldName is present in the map changed.
Collection<PostAggregation>	updateNestedQueryPostAggs(Collection<PostAggregation> nestedQueryPostAggs, Map<String,String> oldFieldNameToNewFieldNameMap, String filterSuffix) Update the nested query post agg names if they are not of the type CONSTANT.
TemplateDruidQuery	updateOuterQuery(TemplateDruidQuery outerQuery, Map<String,String> oldFieldNameToNewFieldNameMap) A method to update outer query aggregations and postAggregations.
Set<Aggregation>	updateQueryAggs(Set<Aggregation> outerAggregations, Map<String,String> oldFieldNameToNewFieldNameMap, Map<String,Aggregation> oldNameToNewAggregationMapping) Update the outer query aggs if their respective inner post agg names are updated.
TemplateDruidQuery	updateTemplateDruidQuery(TemplateDruidQuery query, com.fasterxml.jackson.databind.JsonNode metricFilterObject, DimensionDictionary dimensionDictionary, LogicalTable table, DataApiRequest apiRequest) Method to update a given query by changing aggregators to filteredAggregators and updating postAggs to reference the filteredAggregators.
void	validateDuplicateMetrics(com.fasterxml.jackson.databind.node.ArrayNode metricsJsonArray) This method checks if the metric query contains duplicate metrics and throws a BadApiRequestException in case it does find duplicate metrics.

Method Detail

validateDuplicateMetrics

void validateDuplicateMetrics(com.fasterxml.jackson.databind.node.ArrayNode metricsJsonArray)
                       throws BadApiRequestException

This method checks if the metric query contains duplicate metrics and throws a BadApiRequestException in case it does find duplicate metrics.

Parameters:

metricsJsonArray - A JSONArray containing JSONObjects with name and filter. For Example :

 [{"filter":{"AND":{"dim2|id-in":["abc","xyz"],"dim3|id-in":["mobile","tablet"]}},"name":"metric1"},
 {"filter":{},"name":"metric2"}] 

Throws:

BadApiRequestException - Invalid metric query if the metric query has duplicate metrics

getFilteredLogicalMetric

LogicalMetric getFilteredLogicalMetric(LogicalMetric logicalMetric,
                                       com.fasterxml.jackson.databind.JsonNode metricFilterObject,
                                       DimensionDictionary dimensionDictionary,
                                       LogicalTable table,
                                       DataApiRequest apiRequest)
                                throws DimensionRowNotFoundException

Provides filter wrapped logical metric for the given logical metric.

Parameters:

logicalMetric - The LogicalMetric that needs to be transformed into a filtered Logical Metric

metricFilterObject - A JSON object containing the filter for a given metric. For example:

 {"AND":{"dim2|id-in":["abc","xyz"],"dim3|id-in":["mobile","tablet"]}},"name":"metric" 

dimensionDictionary - Dimension dictionary to look the dimension up in

table - The logical table for the data request

apiRequest - The data api request that will be used to generate the filters

Returns:

A Logical Metric that is filtered

Throws:

DimensionRowNotFoundException - if the dimension mentioned in the metric filter is not found

updateOuterQuery

TemplateDruidQuery updateOuterQuery(TemplateDruidQuery outerQuery,
                                    Map<String,String> oldFieldNameToNewFieldNameMap)

A method to update outer query aggregations and postAggregations.

Parameters:

outerQuery - Outer query of a Logical Metric

oldFieldNameToNewFieldNameMap - Map which contains mapping old name --> new name of the post aggs from the nested query. Eg: foo --> foo-dim1334dim2445

Returns:

TemplateDruidQuery which is generated from updated aggs, post aggs and the given nested query

updateQueryAggs

Set<Aggregation> updateQueryAggs(Set<Aggregation> outerAggregations,
                                 Map<String,String> oldFieldNameToNewFieldNameMap,
                                 Map<String,Aggregation> oldNameToNewAggregationMapping)

Update the outer query aggs if their respective inner post agg names are updated.

Parameters:

outerAggregations - Outer query aggregations

oldFieldNameToNewFieldNameMap - Map which contains mapping old name --> new name of the post aggs from the nested query. Eg: foo --> foo-dim1334dim2445

oldNameToNewAggregationMapping - Empty Map to keep old name as key and new aggregation as value

Returns:

Updated outer query aggregations

updateNestedQueryPostAggs

Collection<PostAggregation> updateNestedQueryPostAggs(Collection<PostAggregation> nestedQueryPostAggs,
                                                      Map<String,String> oldFieldNameToNewFieldNameMap,
                                                      String filterSuffix)

Update the nested query post agg names if they are not of the type CONSTANT.

Parameters:

nestedQueryPostAggs - A set of all the nested query post aggregations

oldFieldNameToNewFieldNameMap - Empty Map to store the mapping old name --> new name of the post aggs. Eg: foo --> foo-dim1334dim2445

filterSuffix - Suffix which is appended to the postAgg name to generate new postAgg name

Returns:

updated inner query post aggregations

updateTemplateDruidQuery

TemplateDruidQuery updateTemplateDruidQuery(TemplateDruidQuery query,
                                            com.fasterxml.jackson.databind.JsonNode metricFilterObject,
                                            DimensionDictionary dimensionDictionary,
                                            LogicalTable table,
                                            DataApiRequest apiRequest)
                                     throws DimensionRowNotFoundException

Method to update a given query by changing aggregators to filteredAggregators and updating postAggs to reference the filteredAggregators.

Parameters:

query - Template druid query of a given Logical Metric. Can also be the nested query but can only contain Sketch aggregations.

metricFilterObject - Metric filter associated with the metric

dimensionDictionary - Dimension dictionary to look the dimension up in

table - The logical table for the data request

apiRequest - The data api request that will be used to generate the filters

Returns:

updated query which contains filtered aggregations

Throws:

DimensionRowNotFoundException - if the dimension row in the metric filter is not found.

replacePostAggregation

PostAggregation replacePostAggregation(SketchSetOperationPostAggFunction func,
                                       PostAggregation postAggregation,
                                       Map<String,List<FilteredAggregation>> filteredAggDictionary)

A method to replace postAggs with new postAggs that access the intersection or union of filteredAggregators.

Parameters:

func - Sketch operation function Ex: INTERSECT, UNION

postAggregation - Post aggregation which needs to be replaced

filteredAggDictionary - Dictionary which holds aggregator name as key and list of FilteredAggregation as value

Returns:

A new PostAggregation formed by replacing its FieldAccessor with intersection of its filtered aggregations and replacing each of the intermediate post aggregations with new post aggregations formed from its new children

replacePostAggWithPostAggFromMap

PostAggregation replacePostAggWithPostAggFromMap(PostAggregation postAggregation,
                                                 Map<String,Aggregation> oldNameToNewAggregationMapping)

Takes a post aggregation and updates its FieldAccessor if its fieldName is present in the map changed.

Parameters:

postAggregation - Outer query post aggregation that needs to be updated

oldNameToNewAggregationMapping - Map with old aggname as key and new aggregation as value

Returns:

updated post aggregation if the referencing aggregation name has changed; Otherwise, as it is

getFilteredAggregation

Set<FilteredAggregation> getFilteredAggregation(com.fasterxml.jackson.databind.JsonNode filter,
                                                Aggregation aggregation,
                                                DimensionDictionary dimensionDictionary,
                                                LogicalTable table,
                                                DataApiRequest apiRequest)
                                         throws DimensionRowNotFoundException

For a given aggregator, this method applies the filter and returns a set of filtered aggregations.

Parameters:

filter - Filter to be used in generating FilteredAggregation

aggregation - Aggregation that needs to be wrapped with Filter in order to generate the FilteredAggregation

dimensionDictionary - Dimension dictionary to look the dimension up in

table - The logical table for the data request

apiRequest - The data api request that will be used to generate the filters

Returns:

A set of FilteredAggregators for the given aggregator and Filter

Throws:

DimensionRowNotFoundException - if the dimension row in the metric filter is not found.

generateMetricName

String generateMetricName(String filterString)

Method to prepare filter string.

Parameters:

filterString - Single dimension filter string

Returns:

Metric name extension created for the filter

gatherFilterDimensions

Set<Dimension> gatherFilterDimensions(Filter filter)

Helper method that calls gatherFilterDimensions(Filter, Set) by passing in filter and an empty HashSet.

Parameters:

filter - Filter object whose dimensions are to be collected

Returns:

Set of dimensions belonging to a Filter

gatherFilterDimensions

Set<Dimension> gatherFilterDimensions(Filter filter,
                                      Set<Dimension> dimensions)

Method to get dimensions from a Filter object.

Parameters:

filter - filter whose dimensions need to be collected

dimensions - Set of dimensions belonging to a filter. Empty when the method is first called.

Returns:

Set of dimensions belonging to a Filter