org.jfree.data.general

## Class SubSeriesDataset

- 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

All Implemented Interfaces:
  java.io.ObjectInputValidation, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, CombinationDataset, Dataset, SeriesChangeListener, SeriesDataset, IntervalXYDataset, OHLCDataset, XYDataset

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.

    public class SubSeriesDataset
    extends AbstractIntervalXYDataset
    implements OHLCDataset, IntervalXYDataset, CombinationDataset

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

See Also:
  Serialized Form

### Constructor Summary

Constructors
Constructor and Description
`SubSeriesDataset(SeriesDataset parent, int series)` Deprecated. Creates a SubSeriesDataset using one series from `parent`.
`SubSeriesDataset(SeriesDataset parent, int[] map)` Deprecated. Creates a SubSeriesDataset using one or more series from `parent`.

### Method Summary

Methods
`java.lang.Number` `getClose(int series, int item)` Deprecated. Returns the close-value for the specified series and item.
`double` `getCloseValue(int series, int item)` Deprecated. Returns the close-value (as a double primitive) for an item within a series.
`java.lang.Number` `getEndX(int series, int item)` Deprecated. Returns the ending X value for the specified series and item.
`java.lang.Number` `getEndY(int series, int item)` Deprecated. Returns the ending Y value for the specified series and item.
`java.lang.Number` `getHigh(int series, int item)` Deprecated. Returns the high-value for the specified series and item.
`double` `getHighValue(int series, int item)` Deprecated. Returns the high-value (as a double primitive) for an item within a series.
`int` `getItemCount(int series)` Deprecated. Returns the number of items in a series.
`java.lang.Number` `getLow(int series, int item)` Deprecated. Returns the low-value for the specified series and item.
`double` `getLowValue(int series, int item)` Deprecated. Returns the low-value (as a double primitive) for an item within a series.
`int[]` `getMap()` Deprecated. Returns a map or indirect indexing form our series into parent's series.
`java.lang.Number` `getOpen(int series, int item)` Deprecated. Returns the open-value for the specified series and item.
`double` `getOpenValue(int series, int item)` Deprecated. Returns the open-value (as a double primitive) for an item within a series.
`SeriesDataset` `getParent()` Deprecated. Returns the parent Dataset of this combination.
`int` `getSeriesCount()` Deprecated. Returns the number of series in the dataset.
`java.lang.Comparable` `getSeriesKey(int series)` Deprecated. Returns the key for a series.
`java.lang.Number` `getStartX(int series, int item)` Deprecated. Returns the starting X value for the specified series and item.
`java.lang.Number` `getStartY(int series, int item)` Deprecated. Returns the starting Y value for the specified series and item.
`java.lang.Number` `getVolume(int series, int item)` Deprecated. Returns the volume.
`double` `getVolumeValue(int series, int item)` Deprecated. Returns the volume-value (as a double primitive) for an item within a series.
`java.lang.Number` `getX(int series, int item)` Deprecated. Returns the X-value for the specified series and item.
`java.lang.Number` `getY(int series, int item)` Deprecated. Returns the Y-value for the specified series and item.

### Methods inherited from class org.jfree.data.xy.AbstractIntervalXYDataset

`getEndXValue, getEndYValue, getStartXValue, getStartYValue`

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

`getDomainOrder, getXValue, getYValue`

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

`indexOf, seriesChanged`

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

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

### Methods inherited from class java.lang.Object

`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

### Methods inherited from interface org.jfree.data.xy.IntervalXYDataset

`getEndXValue, getEndYValue, getStartXValue, getStartYValue`

### Methods inherited from interface org.jfree.data.xy.XYDataset

`getDomainOrder, getXValue, getYValue`

### Methods inherited from interface org.jfree.data.general.SeriesDataset

`indexOf`

### Methods inherited from interface org.jfree.data.general.Dataset

`addChangeListener, getGroup, removeChangeListener, setGroup`

### Constructor Detail

#### SubSeriesDataset

    public SubSeriesDataset(SeriesDataset parent,
                    int[] map)

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

#### SubSeriesDataset

    public SubSeriesDataset(SeriesDataset parent,
                    int series)

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

### Method Detail

#### getHigh

    public java.lang.Number getHigh(int series,
                           int item)

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

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

Specified by:
  `getHigh` in interface `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.

#### getHighValue

    public double getHighValue(int series,
                      int item)

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

Specified by:
  `getHighValue` in interface `OHLCDataset`
Parameters:
  `series` - the series (zero-based index).
  `item` - the item (zero-based index).
Returns:
  The high-value.

#### getLow

    public java.lang.Number getLow(int series,
                          int item)

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

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

Specified by:
  `getLow` in interface `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.

#### getLowValue

    public double getLowValue(int series,
                     int item)

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

Specified by:
  `getLowValue` in interface `OHLCDataset`
Parameters:
  `series` - the series (zero-based index).
  `item` - the item (zero-based index).
Returns:
  The low-value.

#### getOpen

    public java.lang.Number getOpen(int series,
                           int item)

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

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

Specified by:
  `getOpen` in interface `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.

#### getOpenValue

    public double getOpenValue(int series,
                      int item)

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

Specified by:
  `getOpenValue` in interface `OHLCDataset`
Parameters:
  `series` - the series (zero-based index).
  `item` - the item (zero-based index).
Returns:
  The open-value.

#### getClose

    public java.lang.Number getClose(int series,
                            int item)

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

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

Specified by:
  `getClose` in interface `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.

#### getCloseValue

    public double getCloseValue(int series,
                       int item)

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

Specified by:
  `getCloseValue` in interface `OHLCDataset`
Parameters:
  `series` - the series (zero-based index).
  `item` - the item (zero-based index).
Returns:
  The close-value.

#### getVolume

    public java.lang.Number getVolume(int series,
                             int item)

Deprecated.
Returns the volume.

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

Specified by:
  `getVolume` in interface `OHLCDataset`
Parameters:
  `series` - the series (zero based index).
  `item` - the item (zero based index).
Returns:
  The volume.

#### getVolumeValue

    public double getVolumeValue(int series,
                        int item)

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

Specified by:
  `getVolumeValue` in interface `OHLCDataset`
Parameters:
  `series` - the series (zero-based index).
  `item` - the item (zero-based index).
Returns:
  The volume-value.

#### getX

    public java.lang.Number getX(int series,
                        int item)

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

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

Specified by:
  `getX` in interface `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.

#### getY

    public java.lang.Number getY(int series,
                        int item)

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

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

Specified by:
  `getY` in interface `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.

#### getItemCount

    public int getItemCount(int series)

Deprecated.
Returns the number of items in a series.

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

Specified by:
  `getItemCount` in interface `XYDataset`
Parameters:
  `series` - the index of the series of interest (zero-based).
Returns:
  The number of items in a series.

#### getSeriesCount

    public int getSeriesCount()

Deprecated.
Returns the number of series in the dataset.

Specified by:
  `getSeriesCount` in interface `SeriesDataset`
Specified by:
  `getSeriesCount` in class `AbstractSeriesDataset`
Returns:
  The number of series in the dataset.

#### getSeriesKey

    public java.lang.Comparable getSeriesKey(int series)

Deprecated.
Returns the key for a series.

Specified by:
  `getSeriesKey` in interface `SeriesDataset`
Specified by:
  `getSeriesKey` in class `AbstractSeriesDataset`
Parameters:
  `series` - the series (zero-based index).
Returns:
  The name of a series.

#### getStartX

    public java.lang.Number getStartX(int series,
                             int item)

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

Specified by:
  `getStartX` in interface `IntervalXYDataset`
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.

#### getEndX

    public java.lang.Number getEndX(int series,
                           int item)

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

Specified by:
  `getEndX` in interface `IntervalXYDataset`
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.

#### getStartY

    public java.lang.Number getStartY(int series,
                             int item)

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

Specified by:
  `getStartY` in interface `IntervalXYDataset`
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.

#### getEndY

    public java.lang.Number getEndY(int series,
                           int item)

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

Specified by:
  `getEndY` in interface `IntervalXYDataset`
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.

#### getParent

    public SeriesDataset getParent()

Deprecated.
Returns the parent Dataset of this combination.

Specified by:
  `getParent` in interface `CombinationDataset`
Returns:
  The parent Dataset of this combination.

#### getMap

    public int[] getMap()

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

Specified by:
  `getMap` in interface `CombinationDataset`
Returns:
  A map or indirect indexing form our series into parent's series.