public class

YIntervalSeriesCollection

extends AbstractIntervalXYDataset
implements Serializable IntervalXYDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.AbstractIntervalXYDataset
           ↳ org.jfree.data.xy.YIntervalSeriesCollection

Class Overview

A collection of YIntervalSeries objects.

See Also

Summary

Public Constructors
YIntervalSeriesCollection()
Creates a new instance of YIntervalSeriesCollection.
Public Methods
void addSeries(YIntervalSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Object clone()
Returns a clone of this instance.
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.
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.
YIntervalSeries 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.
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.
void removeAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
void removeSeries(YIntervalSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
void removeSeries(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractIntervalXYDataset
From class org.jfree.data.xy.AbstractXYDataset
From class org.jfree.data.general.AbstractSeriesDataset
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesChangeListener
From interface org.jfree.data.general.SeriesDataset
From interface org.jfree.data.xy.IntervalXYDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public YIntervalSeriesCollection ()

Creates a new instance of YIntervalSeriesCollection.

Public Methods

public void addSeries (YIntervalSeries series)

Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters
series the series (null not permitted).

public Object clone ()

Returns a clone of this instance.

Returns
  • A clone.
Throws
CloneNotSupportedException if there is a problem.

public boolean equals (Object obj)

Tests this instance for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public Number getEndX (int series, int item)

Returns the end x-value for an item within a series. This method maps directly to getX(int, int).

Parameters
series the series index.
item the item index.
Returns
  • The x-value.

public Number getEndY (int series, int item)

Returns the end y-value for an item within a series.

Parameters
series the series index.
item the item index.
Returns
  • The end y-value.

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.

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.

public YIntervalSeries 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.

public int getSeriesCount ()

Returns the number of series in the collection.

Returns
  • The series count.

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.

public Number getStartX (int series, int item)

Returns the start x-value for an item within a series. This method maps directly to getX(int, int).

Parameters
series the series index.
item the item index.
Returns
  • The x-value.

public Number getStartY (int series, int item)

Returns the start y-value for an item within a series.

Parameters
series the series index.
item the item index.
Returns
  • The start y-value.

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.

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.

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.

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.

public void removeAllSeries ()

Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.

public void removeSeries (YIntervalSeries series)

Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters
series the series (null not permitted).

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