com.gooddata.md.report.Grid Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2004-2017, GoodData(R) Corporation. All rights reserved.
 * This source code is licensed under the BSD-style license found in the
 * LICENSE.txt file in the root directory of this source tree.
 */
package com.gooddata.md.report;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.gooddata.util.GoodDataToStringBuilder;

import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * Grid content (in report definition)
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Grid {

    private final List columns;
    private final List rows;
    private final List metrics;
    private final Map> sort;
    private final Collection> columnWidths;

    /**
     * Creates new instance.
     * @param columns report's definition columns
     * @param rows report's definition rows
     * @param metrics report's definition metrics
     * @param sort report's sort definition
     * @param columnWidths report columns' widths definition
     *
     * @since 2.0.0
     */
    @JsonCreator
    public Grid(@JsonProperty("columns") @JsonDeserialize(contentUsing = GridElementDeserializer.class)
                        List columns,
                @JsonProperty("rows")  @JsonDeserialize(contentUsing = GridElementDeserializer.class)
                        List rows,
                @JsonProperty("metrics") List metrics,
                @JsonProperty("sort") Map> sort,
                @JsonProperty("columnWidths") Collection> columnWidths) {
        this.columns = columns;
        this.rows = rows;
        this.metrics = metrics;
        this.sort = sort;
        this.columnWidths = columnWidths;
    }

    public Grid(List columns, List rows, List metrics) {
        this.columns = columns;
        this.rows = rows;
        this.metrics = metrics;
        sort = new LinkedHashMap<>();
        sort.put("columns", Collections.emptyList());
        sort.put("rows", Collections.emptyList());
        columnWidths = Collections.emptyList();
    }

    @JsonSerialize(contentUsing = GridElementSerializer.class)
    public List getColumns() {
        return columns;
    }

    @JsonSerialize(contentUsing = GridElementSerializer.class)
    public List getRows() {
        return rows;
    }

    public List getMetrics() {
        return metrics;
    }

    public Collection> getColumnWidths() {
        return columnWidths;
    }

    public Map> getSort() {
        return sort;
    }

    @Override
    public String toString() {
        return GoodDataToStringBuilder.defaultToString(this);
    }
}