org.jfree.data.xy

Class YIntervalSeries

public class YIntervalSeries extends ComparableObjectSeries

A list of (x, y, y-low, y-high) data items.

Since: 1.0.3

See Also: YIntervalSeriesCollection

Constructor Summary
YIntervalSeries(Comparable key)
Creates a new empty series.
YIntervalSeries(Comparable key, boolean autoSort, boolean allowDuplicateXValues)
Constructs a new xy-series that contains no data.
Method Summary
voidadd(double x, double y, double yLow, double yHigh)
Adds a data item to the series.
ComparableObjectItemgetDataItem(int index)
Returns the data item at the specified index.
NumbergetX(int index)
Returns the x-value for the specified item.
doublegetYHighValue(int index)
Returns the upper bound of the y-interval for the specified item in the series.
doublegetYLowValue(int index)
Returns the lower bound of the Y-interval for the specified item in the series.
doublegetYValue(int index)
Returns the y-value for the specified item.

Constructor Detail

YIntervalSeries

public YIntervalSeries(Comparable key)
Creates a new empty series. By default, items added to the series will be sorted into ascending order by x-value, and duplicate x-values will be allowed (these defaults can be modified with another constructor.

Parameters: key the series key (null not permitted).

YIntervalSeries

public YIntervalSeries(Comparable key, boolean autoSort, boolean allowDuplicateXValues)
Constructs a new xy-series that contains no data. You can specify whether or not duplicate x-values are allowed for the series.

Parameters: key the series key (null not permitted). autoSort a flag that controls whether or not the items in the series are sorted. allowDuplicateXValues a flag that controls whether duplicate x-values are allowed.

Method Detail

add

public void add(double x, double y, double yLow, double yHigh)
Adds a data item to the series.

Parameters: x the x-value. y the y-value. yLow the lower bound of the y-interval. yHigh the upper bound of the y-interval.

getDataItem

public ComparableObjectItem getDataItem(int index)
Returns the data item at the specified index.

Parameters: index the item index.

Returns: The data item.

getX

public Number getX(int index)
Returns the x-value for the specified item.

Parameters: index the item index.

Returns: The x-value (never null).

getYHighValue

public double getYHighValue(int index)
Returns the upper bound of the y-interval for the specified item in the series.

Parameters: index the item index.

Returns: The upper bound of the y-interval.

Since: 1.0.5

getYLowValue

public double getYLowValue(int index)
Returns the lower bound of the Y-interval for the specified item in the series.

Parameters: index the item index.

Returns: The lower bound of the Y-interval.

Since: 1.0.5

getYValue

public double getYValue(int index)
Returns the y-value for the specified item.

Parameters: index the item index.

Returns: The y-value.

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