public class

DefaultHeatMapDataset

extends AbstractDataset
implements Serializable Cloneable HeatMapDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.DefaultHeatMapDataset

Class Overview

A default implementation of the HeatMapDataset interface.

Summary

Public Constructors
DefaultHeatMapDataset(int xSamples, int ySamples, double minX, double maxX, double minY, double maxY)
Creates a new dataset where all the z-values are initially 0.
Public Methods
Object clone()
Returns an independent copy of this dataset.
boolean equals(Object obj)
Tests this dataset for equality with an arbitrary object.
double getMaximumXValue()
Returns the highest x-value represented in this dataset.
double getMaximumYValue()
Returns the highest y-value represented in this dataset.
double getMinimumXValue()
Returns the lowest x-value represented in this dataset.
double getMinimumYValue()
Returns the lowest y-value represented in this dataset.
int getXSampleCount()
Returns the number of x values across the width of the dataset.
double getXValue(int xIndex)
A convenience method that returns the x-value for the given index.
int getYSampleCount()
Returns the number of y values (or samples) for the dataset.
double getYValue(int yIndex)
A convenience method that returns the y-value for the given index.
Number getZ(int xIndex, int yIndex)
Returns the z-value at the specified sample position in the dataset.
double getZValue(int xIndex, int yIndex)
Returns the z-value at the specified sample position in the dataset.
void setZValue(int xIndex, int yIndex, double z, boolean notify)
Updates a z-value in the dataset and, if requested, sends a DatasetChangeEvent to all registered listeners.
void setZValue(int xIndex, int yIndex, double z)
Updates a z-value in the dataset and sends a DatasetChangeEvent to all registered listeners.
[Expand]
Inherited Methods
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.HeatMapDataset

Public Constructors

public DefaultHeatMapDataset (int xSamples, int ySamples, double minX, double maxX, double minY, double maxY)

Creates a new dataset where all the z-values are initially 0. This is a fixed size array of z-values.

Parameters
xSamples the number of x-values.
ySamples the number of y-values
minX the minimum x-value in the dataset.
maxX the maximum x-value in the dataset.
minY the minimum y-value in the dataset.
maxY the maximum y-value in the dataset.

Public Methods

public Object clone ()

Returns an independent copy of this dataset.

Returns
  • A clone.
Throws
CloneNotSupportedException

public boolean equals (Object obj)

Tests this dataset for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public double getMaximumXValue ()

Returns the highest x-value represented in this dataset. A requirement of this interface is that this method must never return infinite or Double.NAN values.

Returns
  • The highest x-value represented in this dataset.

public double getMaximumYValue ()

Returns the highest y-value represented in this dataset. A requirement of this interface is that this method must never return infinite or Double.NAN values.

Returns
  • The highest y-value represented in this dataset.

public double getMinimumXValue ()

Returns the lowest x-value represented in this dataset. A requirement of this interface is that this method must never return infinite or Double.NAN values.

Returns
  • The lowest x-value represented in this dataset.

public double getMinimumYValue ()

Returns the lowest y-value represented in this dataset. A requirement of this interface is that this method must never return infinite or Double.NAN values.

Returns
  • The lowest y-value represented in this dataset.

public int getXSampleCount ()

Returns the number of x values across the width of the dataset. The values are evenly spaced between getMinimumXValue() and getMaximumXValue().

Returns
  • The number of x-values (always > 0).

public double getXValue (int xIndex)

A convenience method that returns the x-value for the given index.

Parameters
xIndex the xIndex.
Returns
  • The x-value.

public int getYSampleCount ()

Returns the number of y values (or samples) for the dataset. The values are evenly spaced between getMinimumYValue() and getMaximumYValue().

Returns
  • The number of y-values (always > 0).

public double getYValue (int yIndex)

A convenience method that returns the y-value for the given index.

Parameters
yIndex the yIndex.
Returns
  • The y-value.

public Number getZ (int xIndex, int yIndex)

Returns the z-value at the specified sample position in the dataset. In this implementation, where the underlying values are stored in an array of double primitives, you should avoid using this method and use getZValue(int, int) instead.

Parameters
xIndex the position of the x sample in the dataset.
yIndex the position of the y sample in the dataset.
Returns
  • The z-value.

public double getZValue (int xIndex, int yIndex)

Returns the z-value at the specified sample position in the dataset. For a missing or unknown value, this method should return Double.NAN.

Parameters
xIndex the position of the x sample in the dataset.
yIndex the position of the y sample in the dataset.
Returns
  • The z-value.

public void setZValue (int xIndex, int yIndex, double z, boolean notify)

Updates a z-value in the dataset and, if requested, sends a DatasetChangeEvent to all registered listeners.

Parameters
xIndex the x-index.
yIndex the y-index.
z the new z-value.
notify notify listeners?

public void setZValue (int xIndex, int yIndex, double z)

Updates a z-value in the dataset and sends a DatasetChangeEvent to all registered listeners.

Parameters
xIndex the x-index.
yIndex the y-index.
z the new z-value.