jcckit.data.DataCurve Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of plantuml Show documentation

PlantUML is a component that allows to quickly write : * sequence diagram, * use case diagram, * class diagram, * activity diagram, * component diagram, * state diagram * object diagram

There is a newer version: 8059

Show newest version

/*
 * Copyright 2003-2004, Franz-Josef Elmer, All rights reserved
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details
 * (http://www.gnu.org/copyleft/lesser.html).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package jcckit.data;

import jcckit.util.ConfigParameters;

/**
 *  A curve is a {@link DataContainer} of {@link DataPoint DataPoints}.
 *
 *  @author Franz-Josef Elmer
 */
public class DataCurve extends DataContainer implements DataElement {
  /** Config parameter key. */
  public static final String X_KEY = "x",
                             Y_KEY = "y",
                             TITLE_KEY = "title";

  private final String _title;
  private DataContainer _container;

  /** Creates an empty instance with the specified title. */
  public DataCurve(String title) {
    _title = title;
  }

  /**
   * Creates an instance from the specified config parameters.
   * 
   * 
   *     
   * 
   *     
   *     
   * 
   *     
   * 
   *     
   * Key & Default Value Type Mandatory Description
title = empty string String no Curve title.
x double[] yes x-coordinates of the curve points.
y double[] yes y-coordinates of the curve points.
   */
  public DataCurve(ConfigParameters config) {
    this(config.get(TITLE_KEY, ""));
    double[] xPoints = config.getDoubleArray(X_KEY);
    double[] yPoints = config.getDoubleArray(Y_KEY);
    int n = Math.min(xPoints.length, yPoints.length);
    for (int i = 0; i < n; i++) {
      addElement(new DataPoint(xPoints[i], yPoints[i]));
    }
  }

  /**
   * Returns the {@link DataPlot} containing this curve.
   */
  public DataContainer getContainer() {
    return _container;
  }


  /**
   * Sets the {@link DataPlot} where this is a curve of.
   */
  public void setContainer(DataContainer container) {
    _container = container;
  }

  /** Returns the title of this curve. */
  public String getTitle() {
    return _title;
  }

  /** 
   * Returns true if element is an instance of
   * {@link DataPoint}.
   */
  protected boolean isValid(DataElement element) {
    return element instanceof DataPoint;
  }
}

Key & Default Value	Type	Mandatory	Description
`title =` empty string	`String`	no	Curve title.
`x`	`double[]`	yes	x-coordinates of the curve points.
`y`	`double[]`	yes	y-coordinates of the curve points.