org.jfree.data.xy

Interface XYDataset

public interface XYDataset extends SeriesDataset

An interface through which data in the form of (x, y) items can be accessed.
Method Summary
DomainOrdergetDomainOrder()
Returns the order of the domain (or X) values returned by the dataset.
intgetItemCount(int series)
Returns the number of items in a series.
NumbergetX(int series, int item)
Returns the x-value for an item within a series.
doublegetXValue(int series, int item)
Returns the x-value for an item within a series.
NumbergetY(int series, int item)
Returns the y-value for an item within a series.
doublegetYValue(int series, int item)
Returns the y-value (as a double primitive) for an item within a series.

Method Detail

getDomainOrder

public DomainOrder getDomainOrder()
Returns the order of the domain (or X) values returned by the dataset.

Returns: The order (never null).

getItemCount

public int getItemCount(int series)
Returns the number of items in a series.

It is recommended that classes that implement this method should throw an IllegalArgumentException if the series argument is outside the specified range.

Parameters: series the series index (in the range 0 to getSeriesCount() - 1).

Returns: The item count.

getX

public Number getX(int series, int item)
Returns the x-value for an item within a series. The x-values may or may not be returned in ascending order, that is up to the class implementing the interface.

Parameters: series the series index (in the range 0 to getSeriesCount() - 1). item the item index (in the range 0 to getItemCount(series)).

Returns: The x-value (never null).

getXValue

public double getXValue(int series, int item)
Returns the x-value for an item within a series.

Parameters: series the series index (in the range 0 to getSeriesCount() - 1). item the item index (in the range 0 to getItemCount(series)).

Returns: The x-value.

getY

public Number getY(int series, int item)
Returns the y-value for an item within a series.

Parameters: series the series index (in the range 0 to getSeriesCount() - 1). item the item index (in the range 0 to getItemCount(series)).

Returns: The y-value (possibly null).

getYValue

public double getYValue(int series, int item)
Returns the y-value (as a double primitive) for an item within a series.

Parameters: series the series index (in the range 0 to getSeriesCount() - 1). item the item index (in the range 0 to getItemCount(series)).

Returns: The y-value.

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