org.jfree.data.xy

Class VectorSeries

public class VectorSeries extends ComparableObjectSeries

A list of (x,y, deltaX, deltaY) data items.

Since: 1.0.6

See Also: VectorSeriesCollection

Constructor Summary
VectorSeries(Comparable key)
Creates a new empty series.
VectorSeries(Comparable key, boolean autoSort, boolean allowDuplicateXValues)
Constructs a new series that contains no data.
Method Summary
voidadd(double x, double y, double deltaX, double deltaY)
Adds a data item to the series.
ComparableObjectItemgetDataItem(int index)
Returns the data item at the specified index.
doublegetVectorXValue(int index)
Returns the x-component of the vector for an item in the series.
doublegetVectorYValue(int index)
Returns the y-component of the vector for an item in the series.
doublegetXValue(int index)
Returns the x-value for the specified item.
doublegetYValue(int index)
Returns the y-value for the specified item.
ComparableObjectItemremove(int index)
Removes the item at the specified index and sends a SeriesChangeEvent to all registered listeners.

Constructor Detail

VectorSeries

public VectorSeries(Comparable key)
Creates a new empty series.

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

VectorSeries

public VectorSeries(Comparable key, boolean autoSort, boolean allowDuplicateXValues)
Constructs a new 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 deltaX, double deltaY)
Adds a data item to the series.

Parameters: x the x-value. y the y-value. deltaX the vector x. deltaY the vector y.

getDataItem

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

Parameters: index the item index.

Returns: The data item.

getVectorXValue

public double getVectorXValue(int index)
Returns the x-component of the vector for an item in the series.

Parameters: index the item index.

Returns: The x-component of the vector.

getVectorYValue

public double getVectorYValue(int index)
Returns the y-component of the vector for an item in the series.

Parameters: index the item index.

Returns: The y-component of the vector.

getXValue

public double getXValue(int index)
Returns the x-value for the specified item.

Parameters: index the item index.

Returns: The x-value.

getYValue

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

Parameters: index the item index.

Returns: The y-value.

remove

public ComparableObjectItem remove(int index)
Removes the item at the specified index and sends a SeriesChangeEvent to all registered listeners.

Parameters: index the index.

Returns: The item removed.