com.gooddata.md.ProjectDashboard 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;

import static com.gooddata.util.Validate.notNull;
import static java.util.Arrays.asList;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.gooddata.util.GoodDataToStringBuilder;

import java.util.Collection;
import java.util.Collections;
import java.util.Objects;

/**
 * Project Dashboard of GoodData project.

 * Deserialization only. This object is not complete representation of real 'projectDashboard' object.
 * It contains only dashboard tabs basic definitions (identifier and name).
 */
@JsonTypeName("projectDashboard")
@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ProjectDashboard extends AbstractObj implements Queryable {

    private final Content content;

    private ProjectDashboard(@JsonProperty("meta") Meta meta, @JsonProperty("content") Content content) {
        super(meta);
        this.content = notNull(content, "content");
    }

    public ProjectDashboard(final String title, final Tab... tabs) {
        this(new Meta(title), new Content(asList(tabs)));
    }

    @JsonIgnore
    public Collection getTabs() {
        return content.tabs;
    }

    /**
     * Returns dashboard tab with the given tab name.
     * If tab with such name doesn't exist, returns {@code null}.
     *
     * @param name tab name
     * @return
     * 
     *     dashboard tab with the given name
     *     {@code null} if tab doesn't exist
     * 
     */
    @JsonIgnore
    public Tab getTabByName(String name) {
        for (Tab tab : getTabs()) {
            if (Objects.equals(tab.title, name)) {
                return tab;
            }
        }
        return null;
    }

    public Content getContent() {
        return content;
    }

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

    @JsonIgnoreProperties(ignoreUnknown = true)
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private static class Content {

        private final Collection tabs;

        @JsonProperty("filters")
        private final Collection