org.jfree.data.xy

Interface OHLCDataset

public interface OHLCDataset extends XYDataset

An interface that defines data in the form of (x, high, low, open, close) tuples.

Method Summary
Number	getClose(int series, int item) Returns the y-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	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.
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.
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.
Number	getVolume(int series, int item) Returns the volume 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.

Method Detail

getClose

public Number getClose(int series, int item)

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

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

Returns: The value.

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.

getHigh

public Number getHigh(int series, int item)

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

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

Returns: The value.

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.

getLow

public Number getLow(int series, int item)

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

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

Returns: The value.

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.

getOpen

public Number getOpen(int series, int item)

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

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

Returns: The value.

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.

getVolume

public Number getVolume(int series, int item)

Returns the volume for the specified series and item.

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

Returns: The value.

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.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.