org.jfree.data.general

Class CombinedDataset

public class CombinedDataset extends AbstractIntervalXYDataset implements XYDataset, OHLCDataset, IntervalXYDataset, CombinationDataset

This class can combine instances of XYDataset, OHLCDataset and IntervalXYDataset together exposing the union of all the series under one dataset.

Constructor Summary
	CombinedDataset() Default constructor for an empty combination.
	CombinedDataset(SeriesDataset[] data) Creates a CombinedDataset initialized with an array of SeriesDatasets.

Method Summary
void	add(SeriesDataset data) Adds one SeriesDataset to the combination.
void	add(SeriesDataset[] data) Adds an array of SeriesDataset's to the combination.
void	add(SeriesDataset data, int series) Adds one series from a SeriesDataset to the combination.
int	getChildPosition(Dataset child) Returns the child position.
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 value for the specified series and item.
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.

Constructor Detail

CombinedDataset

public CombinedDataset()

Default constructor for an empty combination.

CombinedDataset

public CombinedDataset(SeriesDataset[] data)

Creates a CombinedDataset initialized with an array of SeriesDatasets.

Parameters: data array of SeriesDataset that contains the SeriesDatasets to combine.

Method Detail

add

public void add(SeriesDataset data)

Adds one SeriesDataset to the combination. Listeners are notified of the change.

Parameters: data the SeriesDataset to add.

add

public void add(SeriesDataset[] data)

Adds an array of SeriesDataset's to the combination. Listeners are notified of the change.

Parameters: data array of SeriesDataset to add

add

public void add(SeriesDataset data, int series)

Adds one series from a SeriesDataset to the combination. Listeners are notified of the change.

Parameters: data the SeriesDataset where series is contained series series to add

getChildPosition

public int getChildPosition(Dataset child)

Returns the child position.

Parameters: child the child dataset.

Returns: The position.

getClose

public Number getClose(int series, int item)

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

Note: throws ClassCastException if the series is 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 value.

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

Returns a map or indirect indexing form our series into parent's series. Prior to calling this method, the client should check getParent() to make sure the CombinationDataset uses the same parent. If not, the map returned by this method will be invalid or null.

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 is 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. If there is more than one parent, or a child is found that is not a CombinationDataset, then returns null.

Returns: The parent Dataset of this combination or null.