org.jfree.data.general

Class SubSeriesDataset

public class SubSeriesDataset extends AbstractIntervalXYDataset implements OHLCDataset, IntervalXYDataset, CombinationDataset

This class will create a dataset with one or more series from another SeriesDataset.
Constructor Summary
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.
Method Summary
NumbergetClose(int series, int item)
Returns the close-value for the specified series and item.
doublegetCloseValue(int series, int item)
Returns the close-value (as a double primitive) for an item within a series.
NumbergetEndX(int series, int item)
Returns the ending X value for the specified series and item.
NumbergetEndY(int series, int item)
Returns the ending Y value for the specified series and item.
NumbergetHigh(int series, int item)
Returns the high-value for the specified series and item.
doublegetHighValue(int series, int item)
Returns the high-value (as a double primitive) for an item within a series.
intgetItemCount(int series)
Returns the number of items in a series.
NumbergetLow(int series, int item)
Returns the low-value for the specified series and item.
doublegetLowValue(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.
NumbergetOpen(int series, int item)
Returns the open-value for the specified series and item.
doublegetOpenValue(int series, int item)
Returns the open-value (as a double primitive) for an item within a series.
SeriesDatasetgetParent()
Returns the parent Dataset of this combination.
intgetSeriesCount()
Returns the number of series in the dataset.
ComparablegetSeriesKey(int series)
Returns the key for a series.
NumbergetStartX(int series, int item)
Returns the starting X value for the specified series and item.
NumbergetStartY(int series, int item)
Returns the starting Y value for the specified series and item.
NumbergetVolume(int series, int item)
Returns the volume.
doublegetVolumeValue(int series, int item)
Returns the volume-value (as a double primitive) for an item within a series.
NumbergetX(int series, int item)
Returns the X-value for the specified series and item.
NumbergetY(int series, int item)
Returns the Y-value for the specified series and item.

Constructor Detail

SubSeriesDataset

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

SubSeriesDataset

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

Method Detail

getClose

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.

getCloseValue

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.

getEndX

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.

getEndY

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.

getHigh

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.

getHighValue

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.

getItemCount

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.

getLow

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.

getLowValue

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.

getMap

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.

getOpen

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.

getOpenValue

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.

getParent

public SeriesDataset getParent()
Returns the parent Dataset of this combination.

Returns: The parent Dataset of this combination.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the dataset.

Returns: The number of series in the dataset.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.

Parameters: series the series (zero-based index).

Returns: The name of a series.

getStartX

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.

getStartY

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.

getVolume

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.

getVolumeValue

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.

getX

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.

getY

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.