public class

VectorSeriesCollection

extends AbstractXYDataset
implements Serializable VectorXYDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.VectorSeriesCollection

Class Overview

A collection of VectorSeries objects.

Summary

Public Constructors
VectorSeriesCollection()
Creates a new instance of VectorSeriesCollection.
Public Methods
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.
[Expand]
Inherited Methods
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.VectorXYDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public VectorSeriesCollection ()

Creates a new instance of VectorSeriesCollection.

Public Methods

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

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

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public int getItemCount (int series)

Returns the number of items in the specified series.

Parameters
series the series (zero-based index).
Returns
  • The item count.
Throws
IllegalArgumentException if series is not in the range 0 to getSeriesCount() - 1.

public VectorSeries 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.

public int getSeriesCount ()

Returns the number of series in the collection.

Returns
  • The series count.

public Comparable getSeriesKey (int series)

Returns the key for a series.

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.

public Vector getVector (int series, int item)

Returns the vector for an item in a series.

Parameters
series the series index.
item the item index.
Returns
  • The vector (possibly null).

public double getVectorXValue (int series, int item)

Returns the x-component of the vector for an item in a series.

Parameters
series the series index.
item the item index.
Returns
  • The x-component of the vector.

public double getVectorYValue (int series, int item)

Returns the y-component of the vector for an item in a series.

Parameters
series the series index.
item the item index.
Returns
  • The y-component of the vector.

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.

Parameters
series the series index.
item the item index.
Returns
  • The x-value.

public double getXValue (int series, int item)

Returns the x-value for an item within a series.

Parameters
series the series index.
item the item index.
Returns
  • The x-value.

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.

Parameters
series the series index.
item the item index.
Returns
  • The y-value.

public double getYValue (int series, int item)

Returns the y-value for an item within a series.

Parameters
series the series index.
item the item index.
Returns
  • The y-value.

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.

public void removeAllSeries ()

Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.

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.