com.yahoo.bard.webservice.web

Class FilteredSketchMetricsHelper

java.lang.Object

com.yahoo.bard.webservice.web.FilteredSketchMetricsHelper

All Implemented Interfaces:

MetricsFilterSetBuilder

Deprecated.

To consider the latest version of sketch Library. This class is replaced by FilteredThetaSketchMetricsHelper class

@Deprecated
public class FilteredSketchMetricsHelper
extends Object
implements MetricsFilterSetBuilder

Class containing helper methods to build filtered metric.

Constructor Summary

Constructors

Constructor and Description
FilteredSketchMetricsHelper() Deprecated.

Method Summary

Modifier and Type	Method and Description
Set<Dimension>	gatherFilterDimensions(Filter filter) Deprecated. Helper method that calls gatherFilterDimensions(Filter filter, Set<Dimension> dimensions) by passing in filter and an empty HashSet.
Set<Dimension>	gatherFilterDimensions(Filter filter, Set<Dimension> dimensions) Deprecated. Method to get dimensions from a Filter object.
String	generateMetricName(String filterString) Deprecated. Method to prepare filter string.
Set<FilteredAggregation>	getFilteredAggregation(com.fasterxml.jackson.databind.JsonNode filter, Aggregation aggregation, DimensionDictionary dimensionDictionary, LogicalTable table, DataApiRequest apiRequest) Deprecated. 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) Deprecated. Provides filter wrapped logical metric for the given logical metric.
PostAggregation	replacePostAggregation(SketchSetOperationPostAggFunction func, PostAggregation postAggregation, Map<String,List<FilteredAggregation>> filteredAggDictionary) Deprecated. A method to replace postAggs with new postAggs that access the intersection or union of filteredAggregators.
PostAggregation	replacePostAggWithPostAggFromMap(PostAggregation postAggregation, Map<String,Aggregation> oldNameToNewAggregationMapping) Deprecated. 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) Deprecated. Update the nested query post agg names if they are not of the type CONSTANT.
TemplateDruidQuery	updateOuterQuery(TemplateDruidQuery outerQuery, Map<String,String> oldFieldNameToNewFieldNameMap) Deprecated. A method to update outer query aggregations & postAggregations.
Set<Aggregation>	updateQueryAggs(Set<Aggregation> outerAggregations, Map<String,String> oldFieldNameToNewFieldNameMap, Map<String,Aggregation> oldNameToNewAggregationMapping) Deprecated. 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) Deprecated. 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) Deprecated. This method checks if the metric query contains duplicate metrics and throws a BadApiRequestException in case it does find duplicate metrics.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredSketchMetricsHelper

public FilteredSketchMetricsHelper()

Deprecated.

Method Detail

validateDuplicateMetrics

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

Deprecated.

Description copied from interface: MetricsFilterSetBuilder

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

Specified by:

validateDuplicateMetrics in interface MetricsFilterSetBuilder

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"}] 

getFilteredLogicalMetric

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

Deprecated.

Description copied from interface: MetricsFilterSetBuilder

Provides filter wrapped logical metric for the given logical metric.

Specified by:

getFilteredLogicalMetric in interface MetricsFilterSetBuilder

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

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

Deprecated.

A method to update outer query aggregations & postAggregations.

Specified by:

updateOuterQuery in interface MetricsFilterSetBuilder

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

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

Deprecated.

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

Specified by:

updateQueryAggs in interface MetricsFilterSetBuilder

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

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

Deprecated.

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

Specified by:

updateNestedQueryPostAggs in interface MetricsFilterSetBuilder

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

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

Deprecated.

Description copied from interface: MetricsFilterSetBuilder

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

Specified by:

updateTemplateDruidQuery in interface MetricsFilterSetBuilder

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

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

Deprecated.

Description copied from interface: MetricsFilterSetBuilder

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

Specified by:

replacePostAggregation in interface MetricsFilterSetBuilder

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

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

Deprecated.

Description copied from interface: MetricsFilterSetBuilder

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

Specified by:

replacePostAggWithPostAggFromMap in interface MetricsFilterSetBuilder

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

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

Deprecated.

Description copied from interface: MetricsFilterSetBuilder

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

Specified by:

getFilteredAggregation in interface MetricsFilterSetBuilder

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

public String generateMetricName(String filterString)

Deprecated.

Description copied from interface: MetricsFilterSetBuilder

Method to prepare filter string.

Specified by:

generateMetricName in interface MetricsFilterSetBuilder

Parameters:

filterString - Single dimension filter string

Returns:

Metric name extension created for the filter

gatherFilterDimensions

public Set<Dimension> gatherFilterDimensions(Filter filter)

Deprecated.

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

Specified by:

gatherFilterDimensions in interface MetricsFilterSetBuilder

Parameters:

filter - Filter object whose dimensions are to be collected

Returns:

Set of dimensions belonging to a Filter

gatherFilterDimensions

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

Deprecated.

Description copied from interface: MetricsFilterSetBuilder

Method to get dimensions from a Filter object.

Specified by:

gatherFilterDimensions in interface MetricsFilterSetBuilder

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