Module platform
Package org.jfree.data.xy

Class VectorSeriesCollection

java.lang.Object
org.jfree.data.general.AbstractDataset
org.jfree.data.general.AbstractSeriesDataset
org.jfree.data.xy.AbstractXYDataset
org.jfree.data.xy.VectorSeriesCollection
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, EventListener, PublicCloneable, Dataset, SeriesChangeListener, SeriesDataset, VectorXYDataset, XYDataset
public class VectorSeriesCollection extends AbstractXYDataset implements VectorXYDataset, PublicCloneable, Serializable
A collection of VectorSeries objects.
See Also:

  • Constructor Details

    • VectorSeriesCollection

      public VectorSeriesCollection()
      Creates a new VectorSeriesCollection instance.

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

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

    • removeAllSeries

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

    • 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 series count.

    • getSeries

      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.

    • getSeriesKey

      public Comparable getSeriesKey(int series)
      Returns the key for a series.
      Specified by:
      getSeriesKey in interface SeriesDataset
      Specified by:
      getSeriesKey in class AbstractSeriesDataset
      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.

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

    • 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.
      Throws:
      IllegalArgumentException - if series is not in the range 0 to getSeriesCount() - 1.

    • 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 class AbstractXYDataset
      Parameters:
      series - the series index.
      item - the item index.
      Returns:
      The x-value.

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

    • 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 class AbstractXYDataset
      Parameters:
      series - the series index.
      item - the item index.
      Returns:
      The y-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.

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

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of this instance.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class AbstractDataset
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if there is a problem.