Package org.jfree.data

Class MatrixSeriesCollection

java.lang.Object
org.jfree.data.AbstractDataset
org.jfree.data.AbstractSeriesDataset
org.jfree.data.AbstractXYDataset
org.jfree.data.AbstractXYZDataset
org.jfree.data.MatrixSeriesCollection
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, EventListener, Dataset, SeriesChangeListener, SeriesDataset, XYDataset, XYZDataset
public class MatrixSeriesCollection
extends AbstractXYZDataset
implements XYZDataset, Serializable
Represents a collection of MatrixSeries that can be used as a dataset.
Author:
Barak Naveh
See Also:
MatrixSeries, Serialized Form

  • Constructor Details

    • MatrixSeriesCollection

      public MatrixSeriesCollection()
      Constructs an empty dataset.

    • MatrixSeriesCollection

      public MatrixSeriesCollection​(MatrixSeries series)
      Constructs a dataset and populates it with a single matrix series.
      Parameters:
      series - the time series.

  • Method Details

    • getItemCount

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

    • getSeries

      public MatrixSeries getSeries​(int seriesIndex)
      Returns the series having the specified index.
      Parameters:
      seriesIndex - zero-based series index.
      Returns:
      The series.
      Throws:
      IllegalArgumentException

    • 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 number of series in the collection.

    • getSeriesName

      public String getSeriesName​(int seriesIndex)
      Returns the name of a series.
      Specified by:
      getSeriesName in interface SeriesDataset
      Specified by:
      getSeriesName in class AbstractSeriesDataset
      Parameters:
      seriesIndex - zero-based series index.
      Returns:
      the name of a series.

    • getXValue

      public Number getXValue​(int seriesIndex, int itemIndex)
      Returns the j index value of the specified Mij matrix item in the specified matrix series.
      Specified by:
      getXValue in interface XYDataset
      Parameters:
      seriesIndex - zero-based series index.
      itemIndex - zero-based item index.
      Returns:
      the j index value for the specified matrix item.
      See Also:
      XYDataset.getXValue(int, int)

    • getYValue

      public Number getYValue​(int seriesIndex, int itemIndex)
      Returns the i index value of the specified Mij matrix item in the specified matrix series.
      Specified by:
      getYValue in interface XYDataset
      Parameters:
      seriesIndex - zero-based series index.
      itemIndex - zero-based item index.
      Returns:
      the i index value for the specified matrix item.
      See Also:
      XYDataset.getYValue(int, int)

    • getZValue

      public Number getZValue​(int seriesIndex, int itemIndex)
      Returns the Mij item value of the specified Mij matrix item in the specified matrix series.
      Specified by:
      getZValue in interface XYZDataset
      Parameters:
      seriesIndex - the series (zero-based index).
      itemIndex - zero-based item index.
      Returns:
      the Mij item value for the specified matrix item.
      See Also:
      XYZDataset.getZValue(int, int)

    • addSeries

      public void addSeries​(MatrixSeries series)
      Adds a series to the collection.

      Notifies all registered listeners that the dataset has changed.

      Parameters:
      series - the series.
      Throws:
      IllegalArgumentException

    • equals

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

    • hashCode

      public int hashCode()
      Returns a hash code.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code.

    • removeAllSeries

      public void removeAllSeries()
      Removes all the series from the collection.

      Notifies all registered listeners that the dataset has changed.

    • removeSeries

      public void removeSeries​(MatrixSeries series)
      Removes a series from the collection.

      Notifies all registered listeners that the dataset has changed.

      Parameters:
      series - the series.
      Throws:
      IllegalArgumentException

    • removeSeries

      public void removeSeries​(int seriesIndex)
      Removes a series from the collection.

      Notifies all registered listeners that the dataset has changed.

      Parameters:
      seriesIndex - the series (zero based index).
      Throws:
      IllegalArgumentException