public class

DefaultHighLowDataset

extends AbstractXYDataset
implements OHLCDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.DefaultHighLowDataset

Class Overview

A simple implementation of the OHLCDataset interface. See also the DefaultOHLCDataset class, which provides another implementation that is very similar.

Summary

Public Constructors
DefaultHighLowDataset(Comparable seriesKey, Date[] date, double[] high, double[] low, double[] open, double[] close, double[] volume)
Constructs a new high/low/open/close dataset.
Public Methods
static Number[] createNumberArray(double[] data)
Constructs an array of Number objects from an array of doubles.
boolean equals(Object obj)
Tests this dataset for equality with an arbitrary instance.
Number getClose(int series, int item)
Returns the close-value for one item in a series.
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 one item in a series.
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 the specified series.
Number getLow(int series, int item)
Returns the low-value for one item in a series.
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 one item in a series.
double getOpenValue(int series, int item)
Returns the open-value (as a double primitive) for an item within a series.
int getSeriesCount()
Returns the number of series in the dataset.
Comparable getSeriesKey(int series)
Returns the key for the series stored in this dataset.
Number getVolume(int series, int item)
Returns the volume-value for one item in a series.
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 one item in a series.
Date getXDate(int series, int item)
Returns the x-value for one item in a series, as a Date.
Number getY(int series, int item)
Returns the y-value for one item in a series.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractXYDataset
From class org.jfree.data.general.AbstractSeriesDataset
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesChangeListener
From interface org.jfree.data.general.SeriesDataset
From interface org.jfree.data.xy.OHLCDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public DefaultHighLowDataset (Comparable seriesKey, Date[] date, double[] high, double[] low, double[] open, double[] close, double[] volume)

Constructs a new high/low/open/close dataset.

The current implementation allows only one series in the dataset. This may be extended in a future version.

Parameters
seriesKey the key for the series (null not permitted).
date the dates (null not permitted).
high the high values (null not permitted).
low the low values (null not permitted).
open the open values (null not permitted).
close the close values (null not permitted).
volume the volume values (null not permitted).

Public Methods

public static Number[] createNumberArray (double[] data)

Constructs an array of Number objects from an array of doubles.

Parameters
data the double values to convert (null not permitted).
Returns
  • The data as an array of Number objects.

public boolean equals (Object obj)

Tests this dataset for equality with an arbitrary instance.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public Number getClose (int series, int item)

Returns the close-value for one item in a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The close-value.
See Also

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

public Number getHigh (int series, int item)

Returns the high-value for one item in a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The high-value.
See Also

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

public int getItemCount (int series)

Returns the number of items in the specified series.

Parameters
series the index (zero-based) of the series.
Returns
  • The number of items in the specified series.

public Number getLow (int series, int item)

Returns the low-value for one item in a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The low-value.
See Also

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

public Number getOpen (int series, int item)

Returns the open-value for one item in a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The open-value.
See Also

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

public int getSeriesCount ()

Returns the number of series in the dataset.

This implementation only allows one series.

Returns
  • The number of series.

public Comparable getSeriesKey (int series)

Returns the key for the series stored in this dataset.

Parameters
series the index of the series (ignored, this dataset supports only one series and this method always returns the key for series 0).
Returns
  • The series key (never null).

public Number getVolume (int series, int item)

Returns the volume-value for one item in a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The volume-value.
See Also

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

public Number getX (int series, int item)

Returns the x-value for one item in a series. The value returned is a Long instance generated from the underlying Date object. To avoid generating a new object instance, you might prefer to call getXValue(int, int).

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The x-value.
See Also

public Date getXDate (int series, int item)

Returns the x-value for one item in a series, as a Date.

This method is provided for convenience only.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The x-value as a Date.
See Also

public Number getY (int series, int item)

Returns the y-value for one item in a series.

This method (from the XYDataset interface) is mapped to the getCloseValue(int, int) method.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The y-value.
See Also