com.yahoo.bard.webservice.web

Class ApiHaving

java.lang.Object

com.yahoo.bard.webservice.web.ApiHaving

public class ApiHaving
extends Object

The Bard-level representation of a Druid Having clause. This class assumes that all metrics in the associated having clause are defined.

Constructor Summary

Constructors

Constructor and Description
ApiHaving(LogicalMetric metric, HavingOperation operation, List<Double> values) Constructor for an ApiHaving object whose data has already been parsed.
ApiHaving(String havingQuery, Map<String,LogicalMetric> metricDictionary) Parses the URL having Query and generates the ApiHaving object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
LogicalMetric	getMetric()
HavingOperation	getOperation()
List<Double>	getValues()
int	hashCode()
ApiHaving	withLogicalMetric(LogicalMetric metric)
ApiHaving	withOperation(HavingOperation operation)
ApiHaving	withValues(List<Double> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiHaving

public ApiHaving(@NotNull
                 String havingQuery,
                 Map<String,LogicalMetric> metricDictionary)
          throws BadHavingException

Parses the URL having Query and generates the ApiHaving object.

Parameters:

havingQuery - Expects a URL having query String in the format:

(metric name)-(operation)[?(value or comma separated numeric values)]?

metricDictionary - cache containing all the valid metric objects.

Throws:

BadHavingException - when having pattern is not matched or when any of its properties are not valid.

ApiHaving

public ApiHaving(LogicalMetric metric,
                 HavingOperation operation,
                 List<Double> values)

Constructor for an ApiHaving object whose data has already been parsed.

Parameters:

metric - The metric to perform the "having" check on.

operation - The operation to perform (i.e. greater than, less than).

values - The numbers to compare the metric to.

Method Detail

withLogicalMetric

public ApiHaving withLogicalMetric(@NotNull
                                   LogicalMetric metric)

withOperation

public ApiHaving withOperation(@NotNull
                               HavingOperation operation)

withValues

public ApiHaving withValues(@NotNull
                            List<Double> values)

getMetric

public LogicalMetric getMetric()

getOperation

public HavingOperation getOperation()

getValues

public List<Double> getValues()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object