io.deepsense.neptune.clientlibrary.models.Chart Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neptune-client-library Show documentation

Enables integration with Neptune in your Java code

There is a newer version: 1.6.1

Show newest version

/**
 * Copyright (c) 2016, CodiLime Inc.
 */

package io.deepsense.neptune.clientlibrary.models;

import java.util.UUID;

/**
 * A chart is a named group of series.
 * Each series consists of a channel and a channel’s label
 * which will be used to display channel values.
 * Series of one chart are displayed together on the same diagram.
 */
public interface Chart {

    /**
     *
     * @return The id of this chart.
     */
    UUID getId();

    /**
     *
     * @return The name of this chart.
     */
    String getName();

    /**
     *
     * @return The series of this chart.
     */
    Iterable getSeries();

    /**
     *
     * Add a series of default type
     * ({@link io.deepsense.neptune.clientlibrary.models.ChartSeriesType#LINE}) to this chart.
     *
     * @param name The series name that will be displayed on the dashboard.
     * @param channel The channel as returned from the job.createChannel().
     */
    void addSeries(String name, Channel channel);

    /**
     *
     * Add a series to this chart.
     *
     * @param name The series name that will be displayed on the dashboard.
     * @param channel The channel as returned from the job.createChannel().
     * @param type The series type
     *     {@link io.deepsense.neptune.clientlibrary.models.ChartSeriesType}
     */
    void addSeries(String name, Channel channel, ChartSeriesType type);
}