public class

DefaultXYZDataset

extends AbstractXYZDataset
implements XYZDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.AbstractXYZDataset
           ↳ org.jfree.data.xy.DefaultXYZDataset

Class Overview

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

Summary

Public Constructors
DefaultXYZDataset()
Creates a new DefaultXYZDataset instance, initially containing no data.
Public Methods
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.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractXYZDataset
From class org.jfree.data.xy.AbstractXYDataset
From class org.jfree.data.general.AbstractSeriesDataset
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesChangeListener
From interface org.jfree.data.general.SeriesDataset
From interface org.jfree.data.xy.XYDataset
From interface org.jfree.data.xy.XYZDataset

Public Constructors

public DefaultXYZDataset ()

Creates a new DefaultXYZDataset instance, initially containing no data.

Public Methods

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

public Object clone ()

Creates an independent copy of this dataset.

Returns
  • The cloned dataset.
Throws
CloneNotSupportedException if there is a problem cloning the dataset (for instance, if a non-cloneable object is used for a series key).

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.

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.

Returns
  • DomainOrder.NONE.

public int getItemCount (int series)

Returns the number of items in the specified series.

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
Returns
  • The item count.
Throws
IllegalArgumentException if series is not in the specified range.

public int getSeriesCount ()

Returns the number of series in the dataset.

Returns
  • The series count.

public Comparable getSeriesKey (int series)

Returns the key for a series.

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
Returns
  • The key for the series.
Throws
IllegalArgumentException if series is not in the specified range.

public Number getX (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.
Throws
ArrayIndexOutOfBoundsException if series is not within the specified range.
ArrayIndexOutOfBoundsException if item is not within the specified range.

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.
Throws
ArrayIndexOutOfBoundsException if series is not within the specified range.
ArrayIndexOutOfBoundsException if item is not within the specified range.
See Also

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.
Throws
ArrayIndexOutOfBoundsException if series is not within the specified range.
ArrayIndexOutOfBoundsException if item is not within the specified range.
See Also

public double getYValue (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.
Throws
ArrayIndexOutOfBoundsException if series is not within the specified range.
ArrayIndexOutOfBoundsException if item is not within the specified range.
See Also

public Number getZ (int series, int item)

Returns the z-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 z-value.
Throws
ArrayIndexOutOfBoundsException if series is not within the specified range.
ArrayIndexOutOfBoundsException if item is not within the specified range.
See Also

public double getZValue (int series, int item)

Returns the z-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 z-value.
Throws
ArrayIndexOutOfBoundsException if series is not within the specified range.
ArrayIndexOutOfBoundsException if item is not within the specified range.
See Also

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.

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.

Parameters
seriesKey the series key (null permitted).
Returns
  • The index, or -1.

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