org.jfree.data.xy

Class DefaultXYZDataset

Implemented Interfaces:
Cloneable, Dataset, EventListener, Serializable, Dataset, ObjectInputValidation, Serializable, SeriesChangeListener, SeriesDataset, XYDataset, XYZDataset

public class DefaultXYZDataset
extends AbstractXYZDataset
implements XYZDataset

A default implementation of the XYZDataset interface that stores data values in arrays of double primitives.
Since:
1.0.2

Constructor Summary

DefaultXYZDataset()
Creates a new DefaultXYZDataset instance, initially containing no data.

Method Summary

void
addSeries(Comparable seriesKey, double[][] data)
Adds a series or if a series with the same key already exists replaces the data for that series, then sends a DatasetChangeEvent to all registered listeners.
Object
clone()
Creates an independent copy of this dataset.
boolean
equals(Object obj)
Tests this DefaultXYDataset instance for equality with an arbitrary object.
DomainOrder
getDomainOrder()
Returns the order of the domain (x-) values in the dataset.
int
getItemCount(int series)
Returns the number of items in the specified series.
int
getSeriesCount()
Returns the number of series in the dataset.
Comparable
getSeriesKey(int series)
Returns the key for a series.
Number
getX(int series, int item)
Returns the x-value for an item within a series.
double
getXValue(int series, int item)
Returns the x-value for an item within a series.
Number
getY(int series, int item)
Returns the y-value for an item within a series.
double
getYValue(int series, int item)
Returns the y-value for an item within a series.
Number
getZ(int series, int item)
Returns the z-value for an item within a series.
double
getZValue(int series, int item)
Returns the z-value for an item within a series.
int
hashCode()
Returns a hash code for this instance.
int
indexOf(Comparable seriesKey)
Returns the index of the series with the specified key, or -1 if there is no such series in the dataset.
void
removeSeries(Comparable seriesKey)
Removes a series from the dataset, then sends a DatasetChangeEvent to all registered listeners.

Methods inherited from class org.jfree.data.xy.AbstractXYZDataset

getZValue

Methods inherited from class org.jfree.data.xy.AbstractXYDataset

getDomainOrder, getXValue, getYValue

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

getSeriesCount, getSeriesKey, indexOf, seriesChanged

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

addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Constructor Details

DefaultXYZDataset

public DefaultXYZDataset()
Creates a new DefaultXYZDataset instance, initially containing no data.

Method Details

addSeries

public void addSeries(Comparable seriesKey,
                      double[][] data)
Adds a series or if a series with the same key already exists replaces the data for that series, then sends a DatasetChangeEvent to all registered listeners.
Parameters:
seriesKey - the series key (null not permitted).
data - the data (must be an array with length 3, containing three arrays of equal length, the first containing the x-values, the second containing the y-values and the third containing the z-values).

clone

public Object clone()
            throws CloneNotSupportedException
Creates an independent copy of this dataset.
Overrides:
clone in interface AbstractDataset
Returns:
The cloned dataset.

equals

public boolean equals(Object obj)
Tests this DefaultXYDataset instance for equality with an arbitrary object. This method returns true if and only if:
  • obj is not null;
  • obj is an instance of DefaultXYDataset;
  • both datasets have the same number of series, each containing exactly the same values.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getDomainOrder

public DomainOrder getDomainOrder()
Returns the order of the domain (x-) values in the dataset. In this implementation, we cannot guarantee that the x-values are ordered, so this method returns DomainOrder.NONE.
Specified by:
getDomainOrder in interface XYDataset
Overrides:
getDomainOrder in interface AbstractXYDataset
Returns:
DomainOrder.NONE.

getItemCount

public int getItemCount(int series)
Returns the number of items in the specified series.
Specified by:
getItemCount in interface XYDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
Returns:
The item count.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the dataset.
Specified by:
getSeriesCount in interface SeriesDataset
Overrides:
getSeriesCount in interface AbstractSeriesDataset
Returns:
The series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
Returns:
The key for the series.

getX

public Number getX(int series,
                   int item)
Returns the x-value for an item within a series.
Specified by:
getX in interface XYDataset
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.

getXValue

public double getXValue(int series,
                        int item)
Returns the x-value for an item within a series.
Specified by:
getXValue in interface XYDataset
Overrides:
getXValue in interface AbstractXYDataset
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.
See Also:
getX(int,int)

getY

public Number getY(int series,
                   int item)
Returns the y-value for an item within a series.
Specified by:
getY in interface XYDataset
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.
See Also:
getX(int,int)

getYValue

public double getYValue(int series,
                        int item)
Returns the y-value for an item within a series.
Specified by:
getYValue in interface XYDataset
Overrides:
getYValue in interface AbstractXYDataset
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.
See Also:
getY(int,int)

getZ

public Number getZ(int series,
                   int item)
Returns the z-value for an item within a series.
Specified by:
getZ in interface XYZDataset
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 z-value.
See Also:
getZ(int,int)

getZValue

public double getZValue(int series,
                        int item)
Returns the z-value for an item within a series.
Specified by:
getZValue in interface XYZDataset
Overrides:
getZValue in interface AbstractXYZDataset
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 z-value.
See Also:
getZ(int,int)

hashCode

public int hashCode()
Returns a hash code for this instance.
Returns:
A hash code.

indexOf

public int indexOf(Comparable seriesKey)
Returns the index of the series with the specified key, or -1 if there is no such series in the dataset.
Specified by:
indexOf in interface SeriesDataset
Overrides:
indexOf in interface AbstractSeriesDataset
Parameters:
seriesKey - the series key (null permitted).
Returns:
The index, or -1.

removeSeries

public void removeSeries(Comparable seriesKey)
Removes a series from the dataset, then sends a DatasetChangeEvent to all registered listeners.
Parameters:
seriesKey - the series key (null not permitted).