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

Implemented Interfaces:: Cloneable, CombinationDataset, Dataset, EventListener, IntervalXYDataset, ObjectInputValidation, OHLCDataset, Serializable, SeriesChangeListener, SeriesDataset, XYDataset

public class SubSeriesDataset

extends AbstractIntervalXYDataset

implements OHLCDataset, IntervalXYDataset, CombinationDataset

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

Author:: Bill Kelemen (bill@kelemen-usa.com)

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

Method Summary
`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.

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
`getSeriesCount`, `getSeriesKey`, `indexOf`, `seriesChanged`

Methods inherited from class org.jfree.data.general.AbstractDataset
`addChangeListener`, `clone`, `fireDatasetChanged`, `getGroup`, `hasListener`, `notifyListeners`, `removeChangeListener`, `setGroup`, `validateObject`

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

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

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

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.

getEndX

public Number getEndX(int series,
                      int item)

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.

getEndY

public Number getEndY(int series,
                      int item)

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.

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

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.

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

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

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.

getMap

public int[] getMap()

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.

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

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.

getParent

public SeriesDataset getParent()

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

getSeriesCount

public int getSeriesCount()

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

getSeriesKey

public Comparable getSeriesKey(int series)

Returns the key for a series.
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
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.
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.

getStartY

public Number getStartY(int series,
                        int item)

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.

getVolume

public Number getVolume(int series,
                        int item)

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)

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

Overview Package Class Use Source Tree Index Deprecated About
Prev Class \| Next Class	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr

org.jfree.data.general

Class SubSeriesDataset

Constructor Summary

Method Summary

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

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

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

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

Constructor Details

SubSeriesDataset

SubSeriesDataset

Method Details

getClose

getCloseValue

getEndX

getEndY

getHigh

getHighValue

getItemCount

getLow

getLowValue

getMap

getOpen

getOpenValue

getParent

getSeriesCount

getSeriesKey

getStartX

getStartY

getVolume

getVolumeValue

getX

getY