Module platform
Package org.jfree.data.xy

Class YIntervalSeriesCollection

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
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, EventListener, PublicCloneable, Dataset, SeriesChangeListener, SeriesDataset, IntervalXYDataset, XYDataset
public class YIntervalSeriesCollection extends AbstractIntervalXYDataset implements IntervalXYDataset, PublicCloneable, Serializable
A collection of YIntervalSeries objects.
See Also:

  • Constructor Details

    • YIntervalSeriesCollection

      public YIntervalSeriesCollection()
      Creates a new instance of YIntervalSeriesCollection.

  • Method Details

    • addSeries

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

    • getSeriesCount

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

    • getSeries

      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.

    • getSeriesKey

      public Comparable getSeriesKey(int series)
      Returns the key for a series.
      Specified by:
      getSeriesKey in interface SeriesDataset
      Specified by:
      getSeriesKey in class AbstractSeriesDataset
      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.

    • 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.
      Throws:
      IllegalArgumentException - if series is not in the range 0 to getSeriesCount() - 1.

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

    • 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 class AbstractXYDataset
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The 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 class AbstractIntervalXYDataset
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The value.
      See Also:

    • 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 class AbstractIntervalXYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The value.
      See Also:

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

    • getStartX

      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).
      Specified by:
      getStartX in interface IntervalXYDataset
      Parameters:
      series - the series index.
      item - the item index.
      Returns:
      The x-value.

    • getEndX

      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).
      Specified by:
      getEndX in interface IntervalXYDataset
      Parameters:
      series - the series index.
      item - the item index.
      Returns:
      The x-value.

    • getStartY

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

    • getEndY

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

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

    • removeSeries

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

    • removeAllSeries

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

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of this instance.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class AbstractDataset
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if there is a problem.