org.jfree.data.xy

Class XYIntervalSeriesCollection

Implemented Interfaces:
Cloneable, Dataset, EventListener, IntervalXYDataset, ObjectInputValidation, Serializable, SeriesChangeListener, SeriesDataset, XYDataset

public class XYIntervalSeriesCollection
extends AbstractIntervalXYDataset
implements IntervalXYDataset, Serializable

A collection of XYIntervalSeries objects.
Since:
1.0.3
See Also:
XYIntervalSeries

Constructor Summary

XYIntervalSeriesCollection()
Creates a new instance of XIntervalSeriesCollection.

Method Summary

void
addSeries(XYIntervalSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Object
clone()
Returns a clone of this dataset.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
Number
getEndX(int series, int item)
Returns the end x-value for an item within a series.
double
getEndXValue(int series, int item)
Returns the end x-value (as a double primitive) for an item within a series.
Number
getEndY(int series, int item)
Returns the end y-value for an item within a series.
double
getEndYValue(int series, int item)
Returns the end y-value (as a double primitive) for an item within a series.
int
getItemCount(int series)
Returns the number of items in the specified series.
XYIntervalSeries
getSeries(int series)
Returns a series from the collection.
int
getSeriesCount()
Returns the number of series in the collection.
Comparable
getSeriesKey(int series)
Returns the key for a series.
Number
getStartX(int series, int item)
Returns the start x-value for an item within a series.
double
getStartXValue(int series, int item)
Returns the start x-value (as a double primitive) for an item within a series.
Number
getStartY(int series, int item)
Returns the start y-value for an item within a series.
double
getStartYValue(int series, int item)
Returns the start y-value (as a double primitive) for an item within a series.
Number
getX(int series, int item)
Returns the x-value for an item within a series.
Number
getY(int series, int item)
Returns the y-value for an item within a series.
double
getYValue(int series, int item)
Returns the y-value (as a double primitive) for an item within a series.

Methods inherited from class org.jfree.data.xy.AbstractIntervalXYDataset

getEndXValue, getEndYValue, getStartXValue, getStartYValue

Methods inherited from class org.jfree.data.xy.AbstractXYDataset

getDomainOrder, getXValue, getYValue

Methods inherited from class org.jfree.data.general.AbstractSeriesDataset

getSeriesCount, getSeriesKey, indexOf, seriesChanged

Methods inherited from class org.jfree.data.general.AbstractDataset

addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Constructor Details

XYIntervalSeriesCollection

public XYIntervalSeriesCollection()
Creates a new instance of XIntervalSeriesCollection.

Method Details

addSeries

public void addSeries(XYIntervalSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Parameters:
series - the series (null not permitted).

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this dataset.
Overrides:
clone in interface AbstractDataset
Returns:
A clone of this dataset.

equals

public boolean equals(Object obj)
Tests this instance for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getEndX

public Number getEndX(int series,
                      int item)
Returns the end x-value for an item within a series.
Specified by:
getEndX in interface IntervalXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getEndXValue

public double getEndXValue(int series,
                           int item)
Returns the end x-value (as a double primitive) for an item within a series.
Specified by:
getEndXValue in interface IntervalXYDataset
Overrides:
getEndXValue in interface AbstractIntervalXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.

getEndY

public Number getEndY(int series,
                      int item)
Returns the end y-value for an item within a series. This method maps directly to getY(int,int).
Specified by:
getEndY in interface IntervalXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The end y-value.

getEndYValue

public double getEndYValue(int series,
                           int item)
Returns the end y-value (as a double primitive) for an item within a series.
Specified by:
getEndYValue in interface IntervalXYDataset
Overrides:
getEndYValue in interface AbstractIntervalXYDataset
Parameters:
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
The value.

getItemCount

public int getItemCount(int series)
Returns the number of items in the specified series.
Specified by:
getItemCount in interface XYDataset
Parameters:
series - the series (zero-based index).
Returns:
The item count.

getSeries

public XYIntervalSeries getSeries(int series)
Returns a series from the collection.
Parameters:
series - the series index (zero-based).
Returns:
The series.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the collection.
Specified by:
getSeriesCount in interface SeriesDataset
Overrides:
getSeriesCount in interface AbstractSeriesDataset
Returns:
The series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
Returns:
The key for a series.

getStartX

public Number getStartX(int series,
                        int item)
Returns the start x-value for an item within a series.
Specified by:
getStartX in interface IntervalXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getStartXValue

public double getStartXValue(int series,
                             int item)
Returns the start x-value (as a double primitive) for an item within a series.
Specified by:
getStartXValue in interface IntervalXYDataset
Overrides:
getStartXValue in interface AbstractIntervalXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.

getStartY

public Number getStartY(int series,
                        int item)
Returns the start y-value for an item within a series. This method maps directly to getY(int,int).
Specified by:
getStartY in interface IntervalXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The start y-value.

getStartYValue

public double getStartYValue(int series,
                             int item)
Returns the start y-value (as a double primitive) for an item within a series.
Specified by:
getStartYValue in interface IntervalXYDataset
Overrides:
getStartYValue in interface AbstractIntervalXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.

getX

public Number getX(int series,
                   int item)
Returns the x-value for an item within a series.
Specified by:
getX in interface XYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getY

public Number getY(int series,
                   int item)
Returns the y-value for an item within a series.
Specified by:
getY in interface XYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The y-value.

getYValue

public double getYValue(int series,
                        int item)
Returns the y-value (as a double primitive) for an item within a series.
Specified by:
getYValue in interface XYDataset
Overrides:
getYValue in interface AbstractXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.