public class

MatrixSeriesCollection

extends AbstractXYZDataset
implements Serializable XYZDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.AbstractXYZDataset
           ↳ org.jfree.data.xy.MatrixSeriesCollection

Class Overview

Represents a collection of MatrixSeries that can be used as a dataset.

See Also

Summary

Public Constructors
MatrixSeriesCollection()
Constructs an empty dataset.
MatrixSeriesCollection(MatrixSeries series)
Constructs a dataset and populates it with a single matrix series.
Public Methods
void addSeries(MatrixSeries series)
Adds a series to the collection.
Object clone()
Returns a clone of this instance.
boolean equals(Object obj)
Tests this collection for equality with an arbitrary object.
int getItemCount(int seriesIndex)
Returns the number of items in the specified series.
MatrixSeries getSeries(int seriesIndex)
Returns the series having the specified index.
int getSeriesCount()
Returns the number of series in the collection.
Comparable getSeriesKey(int seriesIndex)
Returns the key for a series.
Number getX(int seriesIndex, int itemIndex)
Returns the j index value of the specified Mij matrix item in the specified matrix series.
Number getY(int seriesIndex, int itemIndex)
Returns the i index value of the specified Mij matrix item in the specified matrix series.
Number getZ(int seriesIndex, int itemIndex)
Returns the Mij item value of the specified Mij matrix item in the specified matrix series.
int hashCode()
Returns a hash code.
void removeAllSeries()
Removes all the series from the collection.
void removeSeries(MatrixSeries series)
Removes a series from the collection.
void removeSeries(int seriesIndex)
Removes a series from the collection.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractXYZDataset
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.XYDataset
From interface org.jfree.data.xy.XYZDataset

Public Constructors

public MatrixSeriesCollection ()

Constructs an empty dataset.

public MatrixSeriesCollection (MatrixSeries series)

Constructs a dataset and populates it with a single matrix series.

Parameters
series the time series.

Public Methods

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

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 collection for equality with an arbitrary object.

Parameters
obj the object.
Returns
  • A boolean.

public int getItemCount (int seriesIndex)

Returns the number of items in the specified series.

Parameters
seriesIndex zero-based series index.
Returns
  • The number of items in the specified series.

public MatrixSeries getSeries (int seriesIndex)

Returns the series having the specified index.

Parameters
seriesIndex zero-based series index.
Returns
  • The series.
Throws
IllegalArgumentException

public int getSeriesCount ()

Returns the number of series in the collection.

Returns
  • The number of series in the collection.

public Comparable getSeriesKey (int seriesIndex)

Returns the key for a series.

Parameters
seriesIndex zero-based series index.
Returns
  • The key for a series.

public Number getX (int seriesIndex, int itemIndex)

Returns the j index value of the specified Mij matrix item in the specified matrix series.

Parameters
seriesIndex zero-based series index.
itemIndex zero-based item index.
Returns
  • The j index value for the specified matrix item.
See Also

public Number getY (int seriesIndex, int itemIndex)

Returns the i index value of the specified Mij matrix item in the specified matrix series.

Parameters
seriesIndex zero-based series index.
itemIndex zero-based item index.
Returns
  • The i index value for the specified matrix item.
See Also

public Number getZ (int seriesIndex, int itemIndex)

Returns the Mij item value of the specified Mij matrix item in the specified matrix series.

Parameters
seriesIndex the series (zero-based index).
itemIndex zero-based item index.
Returns
  • The Mij item value for the specified matrix item.
See Also

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

public void removeAllSeries ()

Removes all the series from the collection.

Notifies all registered listeners that the dataset has changed.

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

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