org.jfree.data.xy

Class XYIntervalSeriesCollection

public class XYIntervalSeriesCollection extends AbstractIntervalXYDataset implements IntervalXYDataset, PublicCloneable, Serializable

A collection of XYIntervalSeries objects.

Since: 1.0.3

See Also: XYIntervalSeries

Constructor Summary
XYIntervalSeriesCollection()
Creates a new instance of XIntervalSeriesCollection.
Method Summary
voidaddSeries(XYIntervalSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Objectclone()
Returns a clone of this dataset.
booleanequals(Object obj)
Tests this instance for equality with an arbitrary object.
NumbergetEndX(int series, int item)
Returns the end x-value for an item within a series.
doublegetEndXValue(int series, int item)
Returns the end x-value (as a double primitive) for an item within a series.
NumbergetEndY(int series, int item)
Returns the end y-value for an item within a series.
doublegetEndYValue(int series, int item)
Returns the end y-value (as a double primitive) for an item within a series.
intgetItemCount(int series)
Returns the number of items in the specified series.
XYIntervalSeriesgetSeries(int series)
Returns a series from the collection.
intgetSeriesCount()
Returns the number of series in the collection.
ComparablegetSeriesKey(int series)
Returns the key for a series.
NumbergetStartX(int series, int item)
Returns the start x-value for an item within a series.
doublegetStartXValue(int series, int item)
Returns the start x-value (as a double primitive) for an item within a series.
NumbergetStartY(int series, int item)
Returns the start y-value for an item within a series.
doublegetStartYValue(int series, int item)
Returns the start y-value (as a double primitive) for an item within a series.
NumbergetX(int series, int item)
Returns the x-value for an item within a series.
NumbergetY(int series, int item)
Returns the y-value for an item within a series.
doublegetYValue(int series, int item)
Returns the y-value (as a double primitive) for an item within a series.
voidremoveAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
voidremoveSeries(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
voidremoveSeries(XYIntervalSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.

Constructor Detail

XYIntervalSeriesCollection

public XYIntervalSeriesCollection()
Creates a new instance of XIntervalSeriesCollection.

Method Detail

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()
Returns a clone of this dataset.

Returns: A clone of this dataset.

Throws: CloneNotSupportedException if there is a problem cloning.

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.

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.

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 XYIntervalSeriesCollection.

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.

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.

Parameters: series the series (zero-based index).

Returns: The item count.

Throws: IllegalArgumentException if series is not in the range 0 to getSeriesCount() - 1.

getSeries

public XYIntervalSeries getSeries(int series)
Returns a series from the collection.

Parameters: series the series index (zero-based).

Returns: The series.

Throws: IllegalArgumentException if series is not in the range 0 to getSeriesCount() - 1.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the collection.

Returns: The series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.

Parameters: series the series index (in the range 0 to getSeriesCount() - 1).

Returns: The key for a series.

Throws: IllegalArgumentException if series is not in the specified range.

getStartX

public Number getStartX(int series, int item)
Returns the start x-value for an item within a series.

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.

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 XYIntervalSeriesCollection.

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.

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.

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.

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.

Parameters: series the series index (zero-based). item the item index (zero-based).

Returns: The value.

removeAllSeries

public void removeAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.

Since: 1.0.10

removeSeries

public void removeSeries(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters: series the series index (zero-based).

Since: 1.0.10

removeSeries

public void removeSeries(XYIntervalSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters: series the series (null not permitted).

Since: 1.0.10