MetricSettingsBuilder.java

/*
 * Copyright 2014 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed 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.
 */
package org.dashbuilder.displayer;

/**
 * A displayer settings builder for meter charts
 *
 * <pre>
 *   DisplayerSettingsFactory.newMetricSettings()
 *   .dataset("sales")
 *   .column("amount", "sum", "Total amount")
 *   .title("Total Sales")
 *   .titleVisible(true)
 *   .titlePosition("bottom")
 *   .width(250).height(200)
 *   .metric(0, 0, 0, 100000)
 *   .buildSettings());
 * </pre>
 */
public interface MetricSettingsBuilder<T extends MetricSettingsBuilder> extends ChartSettingsBuilder<T> {

    /**
     * Set specific the configuration parameters for this metric chart.
     *
     * <p>All the reference values specified <i>start, warning, critical, and end</i> can be used to customize how the
     * metric is displayed according its current value. </p>
     *
     * @return The DisplayerSettingsBuilder instance that is being used to configure a Meter data displayer.
     */
    T metric(long start, long warning, long critical, long end);
}