Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data.contour

Class DefaultContourDataset

Implemented Interfaces:
Cloneable, ContourDataset, Dataset, EventListener, ObjectInputValidation, Serializable, SeriesChangeListener, SeriesDataset, XYDataset, XYZDataset
Known Direct Subclasses:
NonGridContourDataset
public class DefaultContourDataset
extends AbstractXYZDataset
implements ContourDataset
A convenience class that provides a default implementation of the ContourDataset interface.

Field Summary

protected Comparable
seriesKey
The series name (this dataset supports only one series).
protected int[]
xIndex
The index for the start of each column in the data.
protected Number[]
xValues
Storage for the x values.
protected Number[]
yValues
Storage for the y values.
protected Number[]
zValues
Storage for the z values.

Constructor Summary

DefaultContourDataset()
Creates a new dataset, initially empty.
DefaultContourDataset(Comparable seriesKey, Object[] xData, Object[] yData, Object[] zData)
Constructs a new dataset with the given data.

Method Summary

static Object[]
formObjectArray(double[] data)
Creates an object array from an array of doubles.
static Object[][]
formObjectArray(double[][] data)
Creates an object array from an array of doubles.
int
getItemCount(int series)
Returns the number of items in the specified series.
double
getMaxZValue()
Returns the maximum z-value.
double
getMinZValue()
Returns the minimum z-value.
double
getMinZValue(double minX, double minY, double maxX, double maxY)
Returns the minimum z-value.
int
getSeriesCount()
Returns the number of series.
Comparable
getSeriesKey(int series)
Returns the name of the specified series.
Number
getX(int series, int item)
Returns the x value for the specified series and index (zero-based indices).
int[]
getXIndices()
Returns the index of the xvalues.
Number
getXValue(int item)
Returns an x value.
Number[]
getXValues()
Returns the x values.
Number
getY(int series, int item)
Returns the y value for the specified series and index (zero-based indices).
Number[]
getYValues()
Returns a Number array containing all y values.
Number
getZ(int series, int item)
Returns the z value for the specified series and index (zero-based indices).
Range
getZValueRange(Range x, Range y)
Returns the maximum z-value within visible region of plot.
Number[]
getZValues()
Returns a Number array containing all z values.
int[]
indexX()
Returns an int array contain the index into the x values.
int
indexX(int k)
Given index k, returns the column index containing k.
int
indexY(int k)
Given index k, return the row index containing k.
int
indexZ(int i, int j)
Given column and row indices, returns the k index.
void
initialize(Object[] xData, Object[] yData, Object[] zData)
Initialises the dataset.
boolean
isDateAxis(int axisNumber)
Returns true if axis are dates.
void
setSeriesKeys(Comparable[] seriesKeys)
Sets the names of the series in the data source.

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

Field Details

seriesKey

protected Comparable seriesKey
The series name (this dataset supports only one series).

xIndex

protected int[] xIndex
The index for the start of each column in the data.

xValues

protected Number[] xValues
Storage for the x values.

yValues

protected Number[] yValues
Storage for the y values.

zValues

protected Number[] zValues
Storage for the z values.

Constructor Details

DefaultContourDataset

public DefaultContourDataset()
Creates a new dataset, initially empty.

DefaultContourDataset

public DefaultContourDataset(Comparable seriesKey,
                             Object[] xData,
                             Object[] yData,
                             Object[] zData)
Constructs a new dataset with the given data.
Parameters:
seriesKey - the series key.
xData - the x values.
yData - the y values.
zData - the z values.

Method Details

formObjectArray

public static Object[] formObjectArray(double[] data)
Creates an object array from an array of doubles.
Parameters:
data - the data.
Returns:
An array of Double objects.

formObjectArray

public static Object[][] formObjectArray(double[][] data)
Creates an object array from an array of doubles.
Parameters:
data - the data.
Returns:
An array of Double objects.

getItemCount

public int getItemCount(int series)
Returns the number of items in the specified series. This method is provided to satisfy the XYDataset interface implementation.
Specified by:
getItemCount in interface XYDataset
Parameters:
series - must be zero, as this dataset only supports one series.
Returns:
The item count.

getMaxZValue

public double getMaxZValue()
Returns the maximum z-value.
Specified by:
getMaxZValue in interface ContourDataset
Returns:
The maximum z-value.

getMinZValue

public double getMinZValue()
Returns the minimum z-value.
Specified by:
getMinZValue in interface ContourDataset
Returns:
The minimum z-value.

getMinZValue

public double getMinZValue(double minX,
                           double minY,
                           double maxX,
                           double maxY)
Returns the minimum z-value.
Parameters:
minX - the minimum x value.
minY - the minimum y value.
maxX - the maximum x value.
maxY - the maximum y value.
Returns:
The minimum z-value.

getSeriesCount

public int getSeriesCount()
Returns the number of series.

Required by XYDataset interface (this will always return 1)

Specified by:
getSeriesCount in interface SeriesDataset
Overrides:
getSeriesCount in interface AbstractSeriesDataset
Returns:
1.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the name of the specified series. Method provided to satisfy the XYDataset interface implementation
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
Parameters:
series - must be zero.
Returns:
The series name.

getX

public Number getX(int series,
                   int item)
Returns the x value for the specified series and index (zero-based indices). Required by the XYDataset.
Specified by:
getX in interface XYDataset
Parameters:
series - must be zero;
item - the item index (zero-based).
Returns:
The x value.

getXIndices

public int[] getXIndices()
Returns the index of the xvalues.
Specified by:
getXIndices in interface ContourDataset
Returns:
The x values.

getXValue

public Number getXValue(int item)
Returns an x value.
Parameters:
item - the item index (zero-based).
Returns:
The X value.

getXValues

public Number[] getXValues()
Returns the x values.
Specified by:
getXValues in interface ContourDataset
Returns:
The x values.

getY

public Number getY(int series,
                   int item)
Returns the y value for the specified series and index (zero-based indices). Required by the XYDataset.
Specified by:
getY in interface XYDataset
Parameters:
series - the series index (must be zero for this dataset).
item - the item index (zero-based).
Returns:
The Y value.

getYValues

public Number[] getYValues()
Returns a Number array containing all y values.
Specified by:
getYValues in interface ContourDataset
Returns:
The Y values.

getZ

public Number getZ(int series,
                   int item)
Returns the z value for the specified series and index (zero-based indices). Required by the XYDataset
Specified by:
getZ in interface XYZDataset
Parameters:
series - the series index (must be zero for this dataset).
item - the item index (zero-based).
Returns:
The Z value.

getZValueRange

public Range getZValueRange(Range x,
                            Range y)
Returns the maximum z-value within visible region of plot.
Specified by:
getZValueRange in interface ContourDataset
Parameters:
x - the x range.
y - the y range.
Returns:
The z range.

getZValues

public Number[] getZValues()
Returns a Number array containing all z values.
Specified by:
getZValues in interface ContourDataset
Returns:
The Z values.

indexX

public int[] indexX()
Returns an int array contain the index into the x values.
Specified by:
indexX in interface ContourDataset
Returns:
The X values.

indexX

public int indexX(int k)
Given index k, returns the column index containing k.
Parameters:
k - index of interest.
Returns:
The column index.

indexY

public int indexY(int k)
Given index k, return the row index containing k.
Parameters:
k - index of interest.
Returns:
The row index.

indexZ

public int indexZ(int i,
                  int j)
Given column and row indices, returns the k index.
Parameters:
i - index of along x-axis.
j - index of along y-axis.
Returns:
The Z index.

initialize

public void initialize(Object[] xData,
                       Object[] yData,
                       Object[] zData)
Initialises the dataset.
Parameters:
xData - the x values.
yData - the y values.
zData - the z values.

isDateAxis

public boolean isDateAxis(int axisNumber)
Returns true if axis are dates.
Specified by:
isDateAxis in interface ContourDataset
Parameters:
axisNumber - The axis where 0-x, 1-y, and 2-z.
Returns:
A boolean.

setSeriesKeys

public void setSeriesKeys(Comparable[] seriesKeys)
Sets the names of the series in the data source.
Parameters:
seriesKeys - the keys of the series in the data source.

Overview Package Class Use Source Tree Index Deprecated About