viz/rules/TwoDimensionsOneMeasure.hpp

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 **/

#ifndef QUICKSTEP_VIZ_RULES_TWO_DIMENSIONS_ONE_MEASURE_HPP_
#define QUICKSTEP_VIZ_RULES_TWO_DIMENSIONS_ONE_MEASURE_HPP_

#include "catalog/CatalogTypedefs.hpp"
#include "utility/Macros.hpp"
#include "viz/VizAnalyzer.hpp"
#include "viz/VizContext.hpp"
#include "viz/VizObject.hpp"
#include "viz/configs/HeatMap.hpp"
#include "viz/configs/StackedAreaTimeSeries.hpp"
#include "viz/configs/TimeSeries.hpp"

namespace quickstep {
namespace viz {

/** \addtogroup Viz
 *  @{
 */

class TwoDimensionsOneMeasure : public VizRule {
 public:
  TwoDimensionsOneMeasure(const VizContextPtr &context)
      : VizRule(context) {}

  ~TwoDimensionsOneMeasure() override {}

  void execute() override {
    const AttributeIdVector *dimensions =
        context_->get<AttributeIdVector>("Dimensions");
    CHECK_EQ(2uL, dimensions->getAttributeIds().size());
    const auto &dimension_attr_ids = dimensions->getAttributeIds();

    const AttributeIdVector *measures =
        context_->get<AttributeIdVector>("Measures");
    CHECK_EQ(1uL, measures->getAttributeIds().size());

    std::unique_ptr<VizContext> new_context(new VizContext(context_));
    new_context->set("trace", new StringValue("TwoDimensionsOneMeasure"));

    const VizContextPtr new_context_ptr(new_context.release());

    // TODO: check columns statistics.

    // Try TimeseriesChart
    const VizAnalyzer *analyzer =
        context_->get<VizAnalyzer>("VizAnalyzer");

    for (std::size_t i = 0; i < 2uL; ++i) {
      const attribute_id time_attr_id = dimension_attr_ids.at(i);
      const attribute_id group_attr_id = dimension_attr_ids.at(1-i);

      std::string time_format;
      if (analyzer->isTime(time_attr_id, &time_format)) {
        yield(new TimeSeries(time_attr_id,
                             time_format,
                             group_attr_id,
                             measures->getAttributeIds().front(),
                             new_context_ptr));

        yield(new StackedAreaTimeSeries(time_attr_id,
                                        time_format,
                                        group_attr_id,
                                        measures->getAttributeIds().front(),
                                        new_context_ptr));
      }
    }

    // HeatMap
    for (std::size_t i = 0; i < 2uL; ++i) {
        yield(new HeatMap(dimension_attr_ids.at(i),
                          dimension_attr_ids.at(1-i),
                          measures->getAttributeIds().front(),
                          new_context_ptr));
    }
  }

 private:
  DISALLOW_COPY_AND_ASSIGN(TwoDimensionsOneMeasure);
 };

/** @} */

}  // namespace viz
}  // namespace quickstep

#endif  // QUICKSTEP_VIZ_RULES_TWO_DIMENSIONS_ONE_MEASURE_HPP_