Module org.jfree.chart

Package org.jfree.data.xy

Class YIntervalSeries<S extends Comparable<S>>

java.lang.Object

org.jfree.data.general.Series<K>

org.jfree.data.ComparableObjectSeries<S>

org.jfree.data.xy.YIntervalSeries<S>

All Implemented Interfaces:

Serializable, Cloneable

public class YIntervalSeries<S extends Comparable<S>>
extends ComparableObjectSeries<S>

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

Since:

1.0.3

See Also:

YIntervalSeriesCollection, Serialized Form

Field Summary

Fields inherited from class org.jfree.data.ComparableObjectSeries

data

Constructor Summary

Constructors

Constructor	Description
YIntervalSeries(S key)	Creates a new empty series.
YIntervalSeries(S key, boolean autoSort, boolean allowDuplicateXValues)	Constructs a new xy-series that contains no data.

Method Summary

Modifier and Type	Method	Description
void	add(double x, double y, double yLow, double yHigh)	Adds a data item to the series and sends a SeriesChangeEvent to all registered listeners.
void	add(YIntervalDataItem item, boolean notify)	Adds a data item to the series and, if requested, sends a SeriesChangeEvent to all registered listeners.
ComparableObjectItem	getDataItem(int index)	Returns the data item at the specified index.
Number	getX(int index)	Returns the x-value for the specified item.
double	getYHighValue(int index)	Returns the upper bound of the y-interval for the specified item in the series.
double	getYLowValue(int index)	Returns the lower bound of the Y-interval for the specified item in the series.
double	getYValue(int index)	Returns the y-value for the specified item.

Methods inherited from class org.jfree.data.ComparableObjectSeries

add, add, add, clear, clone, delete, equals, getAllowDuplicateXValues, getAutoSort, getItemCount, getMaximumItemCount, hashCode, indexOf, remove, remove, setMaximumItemCount, update, updateByIndex

Methods inherited from class org.jfree.data.general.Series

addChangeListener, fireSeriesChanged, getKey, getNotify, isEmpty, notifyListeners, removeChangeListener, setNotify

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YIntervalSeries

public YIntervalSeries(S 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(S 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 and sends a SeriesChangeEvent to all registered listeners.

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.

add

public void add(YIntervalDataItem item,
                boolean notify)

Adds a data item to the series and, if requested, sends a SeriesChangeEvent to all registered listeners.

Parameters:

item - the data item (null not permitted).

notify - notify listeners?

Since:

1.0.18

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

getYValue

public double getYValue(int index)

Returns the y-value for the specified item.

Parameters:

index - the item index.

Returns:

The y-value.

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

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

getDataItem

public ComparableObjectItem getDataItem(int index)

Returns the data item at the specified index.

Overrides:

getDataItem in class ComparableObjectSeries<S extends Comparable<S>>

Parameters:

index - the item index.

Returns:

The data item.