org.jfree.data.xy

Class OHLCDataItem

java.lang.Object

org.jfree.data.xy.OHLCDataItem

All Implemented Interfaces:

Serializable, Comparable

public class OHLCDataItem
extends Object
implements Comparable, Serializable

Represents a single (open-high-low-close) data item in an DefaultOHLCDataset. This data item is commonly used to summarise the trading activity of a financial commodity for a fixed period (most often one day).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OHLCDataItem(Date date, double open, double high, double low, double close, double volume) Creates a new item.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object object) Compares this object with the specified object for order.
boolean	equals(Object obj) Checks this instance for equality with an arbitrary object.
Number	getClose() Returns the close value.
Date	getDate() Returns the date that the data item relates to.
Number	getHigh() Returns the high value.
Number	getLow() Returns the low value.
Number	getOpen() Returns the open value.
Number	getVolume() Returns the volume.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OHLCDataItem

public OHLCDataItem(Date date,
                    double open,
                    double high,
                    double low,
                    double close,
                    double volume)

Creates a new item.

Parameters:

date - the date (null not permitted).

open - the open value.

high - the high value.

low - the low value.

close - the close value.

volume - the volume.

Method Detail

getDate

public Date getDate()

Returns the date that the data item relates to.

Returns:

The date (never null).

getOpen

public Number getOpen()

Returns the open value.

Returns:

The open value (never null).

getHigh

public Number getHigh()

Returns the high value.

Returns:

The high value (never null).

getLow

public Number getLow()

Returns the low value.

Returns:

The low value (never null).

getClose

public Number getClose()

Returns the close value.

Returns:

The close value (never null).

getVolume

public Number getVolume()

Returns the volume.

Returns:

The volume (never null).

equals

public boolean equals(Object obj)

Checks this instance for equality with an arbitrary object.

Overrides:

equals in class Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

compareTo

public int compareTo(Object object)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface Comparable

Parameters:

object - the object to compare to.

Returns:

A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.