com.yahoo.bard.webservice.data.ResultSerializationProxy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fili-core Show documentation
Fili web service library provides core capabilities for RESTful aggregation navigation, query planning and metadata
There is a newer version: 1.1.13
// Copyright 2016 Yahoo Inc.
// Licensed under the terms of the Apache license. Please see LICENSE.md file distributed with this work for terms.
package com.yahoo.bard.webservice.data;

import com.yahoo.bard.webservice.data.dimension.DimensionColumn;
import com.yahoo.bard.webservice.data.dimension.DimensionRow;
import com.yahoo.bard.webservice.data.metric.MetricColumn;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;

import org.joda.time.format.ISODateTimeFormat;

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * Simplified version of Result class for json format serialization.
 */
public class ResultSerializationProxy {

    public static final String DIMENSION_VALUES_KEY = "dimensionValues";
    public static final String METRIC_VALUES_KEY = "metricValues";
    public static final String TIMESTAMP_KEY = "timeStamp";

    private final Result result;
    private final Map dimensionValues;
    private final Map metricValues;
    private final String timeStamp;

    /**
     * Constructor.
     *
     * @param result  Result row from a result set
     */
    public ResultSerializationProxy(Result result) {
        this.result = result;
        this.dimensionValues = getDimensionValues(result);
        this.metricValues = getMetricValues(result);
        this.timeStamp = result.getTimestamp(ISODateTimeFormat.dateTime());
    }

    @JsonProperty(DIMENSION_VALUES_KEY)
    public Map getDimensionValues() {
        return dimensionValues;
    }

    @JsonProperty(METRIC_VALUES_KEY)
    public Map getMetricValues() {
        return metricValues;
    }

    @JsonProperty(TIMESTAMP_KEY)
    public String getTimeStamp() {
        return timeStamp;
    }

    /**
     * Get type of class type of metric values mapped with metric names.
     *
     * @return Map of metric names and its value type
     */
    @JsonIgnore
    public Map getMetricValuesType() {
        return result.getMetricValues().entrySet().stream()
                .filter(metricValue -> metricValue != null)
                .collect(Collectors.toMap(k -> k.getKey().getName(), v -> getType(v.getValue())));
    }

    /**
     * Get type of value for a given metric value.
     *
     * @param metricValue  Metric value to find the type
     *
     * @return Type of value. ex: "java.math.BigDecimal" by default it is "java.lang.String"
     */
    private String getType(Object metricValue) {
        return metricValue == null ? String.class.getName() : metricValue.getClass().getName();
    }

    /**
     * Generates the dimension names and its unique id map from Result for custom serialization.
     *
     * @param result  Result object for the custom serialization
     *
     * @return custom map of dimension names and their respective unique id
     */
    private Map getDimensionValues(Result result) {
        LinkedHashMap valueMap = new LinkedHashMap<>();
        for (Map.Entry entry : result.getDimensionRows().entrySet()) {
            String value = entry.getValue() == null ? null : entry.getValue().getKeyValue();
            valueMap.put(entry.getKey().getName(), value);
        }
        return valueMap;
    }

    /**
     * Generates the metric names and their value map from Result for custom serialization.
     *
     * @param result  Result object for the custom serialization
     *
     * @return  custom map of metric names and their values
     */
    private Map getMetricValues(Result result) {
        LinkedHashMap valueMap = new LinkedHashMap<>();
        for (Map.Entry entry : result.getMetricValues().entrySet()) {
            valueMap.put(entry.getKey().getName(), entry.getValue());
        }
        return valueMap;
    }
}