org.jfree.data.xy

Class VectorSeriesCollection

Implemented Interfaces:
Cloneable, Dataset, EventListener, PublicCloneable, Serializable, Dataset, ObjectInputValidation, Serializable, SeriesChangeListener, SeriesDataset, VectorXYDataset, XYDataset

public class VectorSeriesCollection
extends AbstractXYDataset
implements VectorXYDataset, PublicCloneable, Serializable

A collection of VectorSeries objects.
Since:
1.0.6

Constructor Summary

VectorSeriesCollection()
Creates a new instance of VectorSeriesCollection.

Method Summary

void
addSeries(VectorSeries 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.
int
getItemCount(int series)
Returns the number of items in the specified series.
VectorSeries
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.
Vector
getVector(int series, int item)
Returns the vector for an item in a series.
double
getVectorXValue(int series, int item)
Returns the x-component of the vector for an item in a series.
double
getVectorYValue(int series, int item)
Returns the y-component of the vector for an item in a series.
Number
getX(int series, int item)
Returns the x-value for an item within a series.
double
getXValue(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 for an item within a series.
int
indexOf(VectorSeries series)
Returns the index of the specified series, or -1 if that series is not present in the dataset.
void
removeAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
boolean
removeSeries(VectorSeries series)
Removes the specified series from the collection and sends a DatasetChangeEvent to all registered listeners.

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

VectorSeriesCollection

public VectorSeriesCollection()
Creates a new instance of VectorSeriesCollection.

Method Details

addSeries

public void addSeries(VectorSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Parameters:
series - the series (null not permitted).

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 instance for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

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.

getSeries

public VectorSeries getSeries(int series)
Returns a series from the collection.
Parameters:
series - the series index (zero-based).
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 series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
Returns:
The key for a series.

getVector

public Vector getVector(int series,
                        int item)
Returns the vector for an item in a series.
Specified by:
getVector in interface VectorXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The vector (possibly null).

getVectorXValue

public double getVectorXValue(int series,
                              int item)
Returns the x-component of the vector for an item in a series.
Specified by:
getVectorXValue in interface VectorXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-component of the vector.

getVectorYValue

public double getVectorYValue(int series,
                              int item)
Returns the y-component of the vector for an item in a series.
Specified by:
getVectorYValue in interface VectorXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The y-component of the vector.

getX

public Number getX(int series,
                   int item)
Returns the x-value for an item within a series. Note that this method creates a new Double instance every time it is called---use getXValue(int,int) instead, if possible.
Specified by:
getX in interface XYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getXValue

public double getXValue(int series,
                        int item)
Returns the x-value for an item within a series.
Specified by:
getXValue in interface XYDataset
Overrides:
getXValue in interface AbstractXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getY

public Number getY(int series,
                   int item)
Returns the y-value for an item within a series. Note that this method creates a new Double instance every time it is called---use getYValue(int,int) instead, if possible.
Specified by:
getY in interface XYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The y-value.

getYValue

public double getYValue(int series,
                        int item)
Returns the y-value for an item within a series.
Specified by:
getYValue in interface XYDataset
Overrides:
getYValue in interface AbstractXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The y-value.

indexOf

public int indexOf(VectorSeries series)
Returns the index of the specified series, or -1 if that series is not present in the dataset.
Parameters:
series - the series (null not permitted).
Returns:
The series index.

removeAllSeries

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

removeSeries

public boolean removeSeries(VectorSeries series)
Removes the specified series from the collection and sends a DatasetChangeEvent to all registered listeners.
Parameters:
series - the series (null not permitted).
Returns:
A boolean indicating whether the series has actually been removed.