public class

SubSeriesDataset

extends AbstractIntervalXYDataset
implements CombinationDataset IntervalXYDataset OHLCDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.AbstractIntervalXYDataset
           ↳ org.jfree.data.general.SubSeriesDataset

This class is deprecated.
As of version 1.0.13. This class will be removed from JFreeChart 1.2.0 onwards. Anyone needing this facility will need to maintain it outside of JFreeChart.

Class Overview

This class will create a dataset with one or more series from another SeriesDataset.

Summary

Public Constructors
SubSeriesDataset(SeriesDataset parent, int[] map)
Creates a SubSeriesDataset using one or more series from parent.
SubSeriesDataset(SeriesDataset parent, int series)
Creates a SubSeriesDataset using one series from parent.
Public Methods
Number getClose(int series, int item)
Returns the close-value for the specified series and item.
double getCloseValue(int series, int item)
Returns the close-value (as a double primitive) for an item within a series.
Number getEndX(int series, int item)
Returns the ending X value for the specified series and item.
Number getEndY(int series, int item)
Returns the ending Y value for the specified series and item.
Number getHigh(int series, int item)
Returns the high-value for the specified series and item.
double getHighValue(int series, int item)
Returns the high-value (as a double primitive) for an item within a series.
int getItemCount(int series)
Returns the number of items in a series.
Number getLow(int series, int item)
Returns the low-value for the specified series and item.
double getLowValue(int series, int item)
Returns the low-value (as a double primitive) for an item within a series.
int[] getMap()
Returns a map or indirect indexing form our series into parent's series.
Number getOpen(int series, int item)
Returns the open-value for the specified series and item.
double getOpenValue(int series, int item)
Returns the open-value (as a double primitive) for an item within a series.
SeriesDataset getParent()
Returns the parent Dataset of this combination.
int getSeriesCount()
Returns the number of series in the dataset.
Comparable getSeriesKey(int series)
Returns the key for a series.
Number getStartX(int series, int item)
Returns the starting X value for the specified series and item.
Number getStartY(int series, int item)
Returns the starting Y value for the specified series and item.
Number getVolume(int series, int item)
Returns the volume.
double getVolumeValue(int series, int item)
Returns the volume-value (as a double primitive) for an item within a series.
Number getX(int series, int item)
Returns the X-value for the specified series and item.
Number getY(int series, int item)
Returns the Y-value for the specified series and item.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractIntervalXYDataset
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.CombinationDataset
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.IntervalXYDataset
From interface org.jfree.data.xy.OHLCDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public SubSeriesDataset (SeriesDataset parent, int[] map)

Creates a SubSeriesDataset using one or more series from parent. The series to use are passed as an array of int.

Parameters
parent underlying dataset
map int[] of series from parent to include in this Dataset

public SubSeriesDataset (SeriesDataset parent, int series)

Creates a SubSeriesDataset using one series from parent. The series to is passed as an int.

Parameters
parent underlying dataset
series series from parent to include in this Dataset

Public Methods

public Number getClose (int series, int item)

Returns the close-value for the specified series and item.

Note: throws ClassCastException if the series if not from a OHLCDataset.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The close-value for the specified series and item.

public double getCloseValue (int series, int item)

Returns the close-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The close-value.

public Number getEndX (int series, int item)

Returns the ending X value for the specified series and item.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The ending X value for the specified series and item.

public Number getEndY (int series, int item)

Returns the ending Y value for the specified series and item.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The ending Y value for the specified series and item.

public Number getHigh (int series, int item)

Returns the high-value for the specified series and item.

Note: throws ClassCastException if the series if not from a OHLCDataset.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The high-value for the specified series and item.

public double getHighValue (int series, int item)

Returns the high-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The high-value.

public int getItemCount (int series)

Returns the number of items in a series.

Note: throws ClassCastException if the series if not from a XYDataset.

Parameters
series the index of the series of interest (zero-based).
Returns
  • The number of items in a series.

public Number getLow (int series, int item)

Returns the low-value for the specified series and item.

Note: throws ClassCastException if the series if not from a OHLCDataset.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The low-value for the specified series and item.

public double getLowValue (int series, int item)

Returns the low-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The low-value.

public int[] getMap ()

Returns a map or indirect indexing form our series into parent's series.

Returns
  • A map or indirect indexing form our series into parent's series.

public Number getOpen (int series, int item)

Returns the open-value for the specified series and item.

Note: throws ClassCastException if the series if not from a OHLCDataset.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The open-value for the specified series and item.

public double getOpenValue (int series, int item)

Returns the open-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The open-value.

public SeriesDataset getParent ()

Returns the parent Dataset of this combination.

Returns
  • The parent Dataset of this combination.

public int getSeriesCount ()

Returns the number of series in the dataset.

Returns
  • The number of series in the dataset.

public Comparable getSeriesKey (int series)

Returns the key for a series.

Parameters
series the series (zero-based index).
Returns
  • The name of a series.

public Number getStartX (int series, int item)

Returns the starting X value for the specified series and item.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The starting X value for the specified series and item.

public Number getStartY (int series, int item)

Returns the starting Y value for the specified series and item.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The starting Y value for the specified series and item.

public Number getVolume (int series, int item)

Returns the volume.

Note: throws ClassCastException if the series if not from a OHLCDataset.

Parameters
series the series (zero based index).
item the item (zero based index).
Returns
  • The volume.

public double getVolumeValue (int series, int item)

Returns the volume-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The volume-value.

public Number getX (int series, int item)

Returns the X-value for the specified series and item.

Note: throws ClassCastException if the series if not from a XYDataset.

Parameters
series the index of the series of interest (zero-based);
item the index of the item of interest (zero-based).
Returns
  • The X-value for the specified series and item.

public Number getY (int series, int item)

Returns the Y-value for the specified series and item.

Note: throws ClassCastException if the series if not from a XYDataset.

Parameters
series the index of the series of interest (zero-based).
item the index of the item of interest (zero-based).
Returns
  • The Y-value for the specified series and item.