XYPlotLine.java

/*******************************************************************************
 * Mission Control Technologies, Copyright (c) 2009-2012, United States Government
 * as represented by the Administrator of the National Aeronautics and Space 
 * Administration. All rights reserved.
 *
 * The MCT platform is 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.
 *
 * MCT includes source code licensed under additional open source licenses. See 
 * the MCT Open Source Licenses file included with this distribution or the About 
 * MCT Licenses dialog available at runtime from the MCT Help menu for additional 
 * information. 
 *******************************************************************************/
package plotter.xy;

import java.awt.Shape;

import javax.swing.Icon;
import javax.swing.JComponent;

import plotter.DoubleData;

/**
 * Base class for all XY plot lines.
 * @author Adam Crume
 */
public abstract class XYPlotLine extends JComponent {
	private static final long serialVersionUID = 1L;

	/** Shape used to draw the outline of each data point.  May be null. */
	protected Shape pointOutline;

	/** Shape used to fill each data point.  May be null. */
	protected Shape pointFill;

	/** Icon to draw at each data point.  May be null */
	protected Icon pointIcon;

	/**
	 * Returns the X data.
	 * This should not be modified directly.
	 * @return X data
	 */
	public abstract DoubleData getXData();


	/**
	 * Returns the Y data.
	 * This should not be modified directly.
	 * @return Y data
	 */
	public abstract DoubleData getYData();


	/**
	 * Adds a data point.
	 * @param x X-coordinate of the data point
	 * @param y Y-coordinate of the data point
	 */
	public abstract void add(double x, double y);


	/**
	 * Repaints a data point and adjoining line segments.
	 * @param index index of the data point
	 */
	public abstract void repaintData(int index);


	/**
	 * Repaints data points and adjoining line segments.
	 * @param index index of the first data point
	 * @param count number of data points
	 */
	public abstract void repaintData(int index, int count);


	/**
	 * Returns the independent dimension.  May be null.
	 * @return the independent dimension
	 */
	public abstract XYDimension getIndependentDimension();


	/**
	 * Adds data to the beginning.
	 * @param x X data to add
	 * @param y Y data to add
	 */
	public abstract void prepend(DoubleData x, DoubleData y);


	/**
	 * Adds data to the beginning.
	 * @param x X data to add
	 * @param xoff index within <code>x</code> to start copying from
	 * @param y Y data to add
	 * @param yoff index within <code>y</code> to start copying from
	 * @param len number of points to add
	 */
	public abstract void prepend(double[] x, int xoff, double[] y, int yoff, int len);


	/**
	 * Removes points from the beginning.
	 * @param removeCount number of points to remove
	 */
	public abstract void removeFirst(int removeCount);


	/**
	 * Removes points from the end.
	 * @param removeCount number of points to remove
	 */
	public abstract void removeLast(int removeCount);


	/**
	 * Removes all points.
	 */
	public abstract void removeAllPoints();


	/**
	 * Returns the point outline.
	 * @return the point outline
	 */
	public Shape getPointOutline() {
		return pointOutline;
	}


	/**
	 * Sets the point outline
	 * @param pointOutline the point outline
	 */
	public void setPointOutline(Shape pointOutline) {
		this.pointOutline = pointOutline;
	}


	/**
	 * Returns the point fill.
	 * @return the point fill
	 */
	public Shape getPointFill() {
		return pointFill;
	}


	/**
	 * Sets the point fill.
	 * @param pointFill the point fill
	 */
	public void setPointFill(Shape pointFill) {
		this.pointFill = pointFill;
	}


	/**
	 * @return the icon used to draw each data point
	 */
	public Icon getPointIcon() {
		return pointIcon;
	}


	/**
	 * @param pointIcon the icon to draw at each data point
	 */
	public void setPointIcon(Icon pointIcon) {
		this.pointIcon = pointIcon;
	}
}