com.googlecode.wickedcharts.highcharts.options.livedata.LiveDataSeries Maven / Gradle / Ivy

Go to download
/**
 *   Copyright 2012-2013 Wicked Charts (http://wicked-charts.googlecode.com)
 *
 *   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 com.googlecode.wickedcharts.highcharts.options.livedata;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.googlecode.wickedcharts.highcharts.options.IProcessableOption;
import com.googlecode.wickedcharts.highcharts.options.Options;
import com.googlecode.wickedcharts.highcharts.options.series.Coordinate;
import com.googlecode.wickedcharts.highcharts.options.series.PointSeries;

/**
 * This Series class supports regular updating via AJAX.
 * 
 * @author Tom Hombergs ([email protected])
 * 
 */
public abstract class LiveDataSeries extends PointSeries implements IProcessableOption {

  private static final long serialVersionUID = 1L;

  /**
   * The key under which {@link LiveDataSeries} are registered in the parent
   * options. See {@link Options#markForProcessing(IProcessableOption)} .
   */
  public static final String PROCESSING_KEY = "LIVEUPDATE";

  @JsonIgnore
  private final Options parentOptions;

  @JsonIgnore
  private int updateIntervalMs;

  /**
   * Constructs a new {@link LiveDataSeries}.
   * 
   * @param parentOptions
   *          the {@link Options} to which this series are added.
   * @param updateIntervalMs
   *          the interval in which to update the series in milliseconds.
   */
  public LiveDataSeries(Options parentOptions, int updateIntervalMs) {
    this.parentOptions = parentOptions;
    this.setUpdateIntervalMs(updateIntervalMs);
    parentOptions.markForProcessing(this);
  }

  public Options getParentOptions() {
    return parentOptions;
  }

  public void setUpdateIntervalMs(int updateIntervalMs) {
    this.updateIntervalMs = updateIntervalMs;
  }

  public int getUpdateIntervalMs() {
    return updateIntervalMs;
  }

  @Override
  @JsonIgnore
  public String getProcessingKey() {
    return PROCESSING_KEY;
  };

  /**
   * This method is called for each update interval. It must return a coordinate
   * which is then added to the series on the fly.
   * 
   * May return null. In that case, the chart is simply not updated.
   * 
   * @return the new {@link Coordinate} to add to the series.
   */
  public abstract Coordinate update();

}