com.yahoo.bard.webservice.web.apirequest

Class DefaultHavingApiGenerator

java.lang.Object

com.yahoo.bard.webservice.web.apirequest.DefaultHavingApiGenerator

All Implemented Interfaces:

HavingGenerator, BiFunction<String,Set<LogicalMetric>,Map<LogicalMetric,Set<ApiHaving>>>

public class DefaultHavingApiGenerator
extends Object
implements HavingGenerator

Generates having objects based on the having query in the api request.

Constructor Summary

Constructors

Constructor and Description
DefaultHavingApiGenerator(ConfigurationLoader loader) Constructor.
DefaultHavingApiGenerator(Map<String,LogicalMetric> metricDictionary) Constructor.

Method Summary

Modifier and Type	Method and Description
Map<LogicalMetric,Set<ApiHaving>>	apply(String havingQuery, Set<LogicalMetric> logicalMetrics) Generates having objects based on the having query in the api request.
HavingGenerator	withMetricDictionary(Map<String,LogicalMetric> metricDictionary) Rebuild this having generator with a custom metric dictionary.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Constructor Detail

DefaultHavingApiGenerator

public DefaultHavingApiGenerator(ConfigurationLoader loader)

Constructor.

Uses the globally scoped set of metrics to resolve having clauses.

Parameters:

loader - Configuration loader that connects resource dictionaries with the loader.

DefaultHavingApiGenerator

public DefaultHavingApiGenerator(Map<String,LogicalMetric> metricDictionary)

Constructor.

Parameters:

metricDictionary - Dictionary of metrics for generating APIs

Method Detail

apply

public Map<LogicalMetric,Set<ApiHaving>> apply(String havingQuery,
                                               Set<LogicalMetric> logicalMetrics)
                                        throws BadApiRequestException

Generates having objects based on the having query in the api request.

Specified by:

apply in interface BiFunction<String,Set<LogicalMetric>,Map<LogicalMetric,Set<ApiHaving>>>

Parameters:

havingQuery - Expects a URL having query String in the format: (dimension name)-(operation)[(value or comma separated values)]?

logicalMetrics - The logical metrics used in this query

Returns:

Set of having objects.

Throws:

BadApiRequestException - if the having query string does not match required syntax.

withMetricDictionary

public HavingGenerator withMetricDictionary(Map<String,LogicalMetric> metricDictionary)

Rebuild this having generator with a custom metric dictionary.

Parameters:

metricDictionary - An alternate dictionary.

Returns:

A replacement metric dictionary