org.jfree.data.contour

Class DefaultContourDataset

public class DefaultContourDataset extends AbstractXYZDataset implements ContourDataset

Deprecated: This class is no longer supported (as of version 1.0.4). If you are creating contour plots, please try to use XYPlot and XYBlockRenderer.

A convenience class that provides a default implementation of the ContourDataset interface.
Field Summary
protected ComparableseriesKey
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.
intgetItemCount(int series)
Returns the number of items in the specified series.
doublegetMaxZValue()
Returns the maximum z-value.
doublegetMinZValue()
Returns the minimum z-value.
doublegetMinZValue(double minX, double minY, double maxX, double maxY)
Returns the minimum z-value.
intgetSeriesCount()
Returns the number of series.
ComparablegetSeriesKey(int series)
Returns the name of the specified series.
NumbergetX(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.
NumbergetXValue(int item)
Returns an x value.
Number[]getXValues()
Returns the x values.
NumbergetY(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.
NumbergetZ(int series, int item)
Returns the z value for the specified series and index (zero-based indices).
RangegetZValueRange(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.
intindexX(int k)
Given index k, returns the column index containing k.
intindexY(int k)
Given index k, return the row index containing k.
intindexZ(int i, int j)
Given column and row indices, returns the k index.
voidinitialize(Object[] xData, Object[] yData, Object[] zData)
Initialises the dataset.
booleanisDateAxis(int axisNumber)
Returns true if axis are dates.
voidsetSeriesKeys(Comparable[] seriesKeys)
Sets the names of the series in the data source.

Field Detail

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 Detail

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 Detail

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.

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.

Returns: The maximum z-value.

getMinZValue

public double getMinZValue()
Returns the minimum z-value.

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)

Returns: 1.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the name of the specified series. Method provided to satisfy the XYDataset interface implementation

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.

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.

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.

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.

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.

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

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.

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.

Returns: The Z values.

indexX

public int[] indexX()
Returns an int array contain the index into the x values.

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.

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.

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