Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data.xy

Class MatrixSeriesCollection

Implemented Interfaces:
Cloneable, Dataset, EventListener, ObjectInputValidation, Serializable, 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.
See Also:
MatrixSeries

Constructor Summary

MatrixSeriesCollection()
Constructs an empty dataset.
MatrixSeriesCollection(MatrixSeries series)
Constructs a dataset and populates it with a single matrix series.

Method Summary

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(int seriesIndex)
Removes a series from the collection.
void
removeSeries(MatrixSeries series)
Removes a series from the collection.

Methods inherited from class org.jfree.data.xy.AbstractXYZDataset

getZValue

Methods inherited from class org.jfree.data.xy.AbstractXYDataset

getDomainOrder, getXValue, getYValue

Methods inherited from class org.jfree.data.general.AbstractSeriesDataset

getSeriesCount, getSeriesKey, indexOf, seriesChanged

Methods inherited from class org.jfree.data.general.AbstractDataset

addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

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

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.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this instance.
Overrides:
clone in interface AbstractDataset
Returns:
A clone.

equals

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

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.

getSeriesCount

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

getSeriesKey

public Comparable getSeriesKey(int seriesIndex)
Returns the key for a series.
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
Parameters:
seriesIndex - zero-based series index.
Returns:
The key for a series.

getX

public Number getX(int seriesIndex,
                   int itemIndex)
Returns the j index value of the specified Mij matrix item in the specified matrix series.
Specified by:
getX 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)

getY

public Number getY(int seriesIndex,
                   int itemIndex)
Returns the i index value of the specified Mij matrix item in the specified matrix series.
Specified by:
getY 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)

getZ

public Number getZ(int seriesIndex,
                   int itemIndex)
Returns the Mij item value of the specified Mij matrix item in the specified matrix series.
Specified by:
getZ 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)

hashCode

public int hashCode()
Returns a hash code.
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(int seriesIndex)
Removes a series from the collection.

Notifies all registered listeners that the dataset has changed.

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

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.

Overview Package Class Use Source Tree Index Deprecated About