com.yahoo.bard.webservice.data

Class Result

java.lang.Object

com.yahoo.bard.webservice.data.Result

public class Result
extends Object

A single row of results.

Constructor Summary

Constructors

Constructor and Description
Result(Map<DimensionColumn,DimensionRow> dimensionRows, Map<MetricColumn,Object> metricValues, org.joda.time.DateTime timeStamp) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
DimensionRow	getDimensionRow(DimensionColumn dimensionColumn) Fetch a DimensionRow from dimensionValues based on the column provided.
Map<DimensionColumn,DimensionRow>	getDimensionRows() The dimensions in the result row expressed as an unmodifiable map keyed by columns.
Object	getMetricValue(MetricColumn column) Fetches the metric value associated with the specified metric column.
boolean	getMetricValueAsBoolean(MetricColumn metricColumn) Fetch the value of the specified metric as a boolean.
com.fasterxml.jackson.databind.JsonNode	getMetricValueAsJsonNode(MetricColumn metricColumn) Fetch the value of the specified metric as a JsonNode.
BigDecimal	getMetricValueAsNumber(MetricColumn metricColumn) Fetch the value of the specified numeric metric.
String	getMetricValueAsString(MetricColumn metricColumn) Fetch the String representation of the value of the specified metric.
Map<MetricColumn,Object>	getMetricValues() The metrics in the result row expressed as an unmodifiable map keyed by columns.
org.joda.time.DateTime	getTimeStamp() The timestamp representing the start moment of the aggregated record.
int	hashCode()
String	toString()
Result	withMetricValue(MetricColumn metricColumn, Object value) Copy the result, adding or replacing the value of a metric

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result(Map<DimensionColumn,DimensionRow> dimensionRows,
              Map<MetricColumn,Object> metricValues,
              org.joda.time.DateTime timeStamp)

Constructor.

Parameters:

dimensionRows - The dimensions in the result expressed as a map keyed by columns

metricValues - The metrics in the result expressed as a map keyed by columns

timeStamp - The timestamp of the result

Method Detail

withMetricValue

public Result withMetricValue(MetricColumn metricColumn,
                              Object value)

Copy the result, adding or replacing the value of a metric

Don't add a without column method because removing columns is far less safe.

Parameters:

metricColumn - The metric column

value - The new value for that column

Returns:

A new result based on this one

getDimensionRows

public Map<DimensionColumn,DimensionRow> getDimensionRows()

The dimensions in the result row expressed as an unmodifiable map keyed by columns.

Returns:

UnmodifiableMap of DimensionColumn to DimensionRow

getMetricValues

public Map<MetricColumn,Object> getMetricValues()

The metrics in the result row expressed as an unmodifiable map keyed by columns.

Returns:

UnmodifiableMap of MetricColumn to Object

getTimeStamp

public org.joda.time.DateTime getTimeStamp()

The timestamp representing the start moment of the aggregated record.

Returns:

timestamp

getDimensionRow

public DimensionRow getDimensionRow(DimensionColumn dimensionColumn)

Fetch a DimensionRow from dimensionValues based on the column provided.

Parameters:

dimensionColumn - The column whose associated value is desired

Returns:

DimensionRow in dimensionValues map corresponding to the column provided as argument

getMetricValue

public Object getMetricValue(MetricColumn column)

Fetches the metric value associated with the specified metric column.

This method should only be used when the caller does not care about the type of the value returned. If the type is important, either getMetricValueAsNumber(MetricColumn), getMetricValueAsString(MetricColumn), getMetricValueAsBoolean(MetricColumn) or getMetricValueAsJsonNode(MetricColumn) should be used, depending on the desired type.

Parameters:

column - The metric column whose value is desired

Returns:

The value of the specified column as an Object

getMetricValueAsNumber

public BigDecimal getMetricValueAsNumber(MetricColumn metricColumn)

Fetch the value of the specified numeric metric.

Parameters:

metricColumn - The metric column whose value is desired

Returns:

The value associated to the desired metric as a BigDecimal

Throws:

ClassCastException - if the value keyed to metricColumn is not a BigDecimal

getMetricValueAsString

public String getMetricValueAsString(MetricColumn metricColumn)

Fetch the String representation of the value of the specified metric.

Parameters:

metricColumn - The metric column whose value is desired

Returns:

The String representation of the value of the desired metric

getMetricValueAsBoolean

public boolean getMetricValueAsBoolean(MetricColumn metricColumn)

Fetch the value of the specified metric as a boolean.

Parameters:

metricColumn - The metric column whose value is desired

Returns:

The boolean value of the desired metric

Throws:

ClassCastException - if the value keyed to metricColumn is not a boolean

getMetricValueAsJsonNode

public com.fasterxml.jackson.databind.JsonNode getMetricValueAsJsonNode(MetricColumn metricColumn)

Fetch the value of the specified metric as a JsonNode.

Parameters:

metricColumn - The metric column whose value is desired

Returns:

The JsonNode associated to the desired metric

Throws:

ClassCastException - if the value keyed to metricColumn is not a JsonNode

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object