org.jfree.data.xy.XYIntervalSeries Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D APIs, it currently supports bar charts, pie charts,
line charts, XY-plots and time series plots.
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2014, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* 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 library 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.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* ---------------------
* XYIntervalSeries.java
* ---------------------
* (C) Copyright 2006-2014, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 20-Oct-2006 : Version 1 (DG);
* 13-Feb-2007 : Added several new accessor methods (DG);
* 09-Jan-2014 : Added add(XYIntervalDataItem, boolean) method (DG);
*
*/
package org.jfree.data.xy;
import org.jfree.data.ComparableObjectItem;
import org.jfree.data.ComparableObjectSeries;
import org.jfree.data.general.SeriesChangeEvent;
/**
* A list of (x, x-low, x-high, y, y-low, y-high) data items.
*
* @since 1.0.3
*
* @see XYIntervalSeriesCollection
*/
public class XYIntervalSeries extends ComparableObjectSeries {
/**
* Creates a new empty series. By default, items added to the series will
* be sorted into ascending order by x-value, and duplicate x-values will
* be allowed (these defaults can be modified with another constructor).
*
* @param key the series key (null not permitted).
*/
public XYIntervalSeries(Comparable key) {
this(key, true, true);
}
/**
* Constructs a new xy-series that contains no data. You can specify
* whether or not duplicate x-values are allowed for the series.
*
* @param key the series key (null not permitted).
* @param autoSort a flag that controls whether or not the items in the
* series are sorted.
* @param allowDuplicateXValues a flag that controls whether duplicate
* x-values are allowed.
*/
public XYIntervalSeries(Comparable key, boolean autoSort,
boolean allowDuplicateXValues) {
super(key, autoSort, allowDuplicateXValues);
}
/**
* Adds a data item to the series and sends a {@link SeriesChangeEvent} to
* all registered listeners.
*
* @param x the x-value.
* @param xLow the lower bound of the x-interval.
* @param xHigh the upper bound of the x-interval.
* @param y the y-value.
* @param yLow the lower bound of the y-interval.
* @param yHigh the upper bound of the y-interval.
*/
public void add(double x, double xLow, double xHigh, double y, double yLow,
double yHigh) {
add(new XYIntervalDataItem(x, xLow, xHigh, y, yLow, yHigh), true);
}
/**
* Adds a data item to the series and, if requested, sends a
* {@link SeriesChangeEvent} to all registered listeners.
*
* @param item the data item (null not permitted).
* @param notify notify listeners?
*
* @since 1.0.18
*/
public void add(XYIntervalDataItem item, boolean notify) {
super.add(item, notify);
}
/**
* Returns the x-value for the specified item.
*
* @param index the item index.
*
* @return The x-value (never null).
*/
public Number getX(int index) {
XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
return item.getX();
}
/**
* Returns the lower bound of the x-interval for the specified item in the
* series.
*
* @param index the item index.
*
* @return The lower bound of the x-interval.
*
* @since 1.0.5
*/
public double getXLowValue(int index) {
XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
return item.getXLowValue();
}
/**
* Returns the upper bound of the x-interval for the specified item in the
* series.
*
* @param index the item index.
*
* @return The upper bound of the x-interval.
*
* @since 1.0.5
*/
public double getXHighValue(int index) {
XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
return item.getXHighValue();
}
/**
* Returns the y-value for the specified item.
*
* @param index the item index.
*
* @return The y-value.
*/
public double getYValue(int index) {
XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
return item.getYValue();
}
/**
* Returns the lower bound of the Y-interval for the specified item in the
* series.
*
* @param index the item index.
*
* @return The lower bound of the Y-interval.
*
* @since 1.0.5
*/
public double getYLowValue(int index) {
XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
return item.getYLowValue();
}
/**
* Returns the upper bound of the y-interval for the specified item in the
* series.
*
* @param index the item index.
*
* @return The upper bound of the y-interval.
*
* @since 1.0.5
*/
public double getYHighValue(int index) {
XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
return item.getYHighValue();
}
/**
* Returns the data item at the specified index.
*
* @param index the item index.
*
* @return The data item.
*/
@Override
public ComparableObjectItem getDataItem(int index) {
return super.getDataItem(index);
}
}