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

Class HistogramDataset

Implemented Interfaces:
Cloneable, Dataset, EventListener, IntervalXYDataset, ObjectInputValidation, PublicCloneable, Serializable, SeriesChangeListener, SeriesDataset, XYDataset
public class HistogramDataset
extends AbstractIntervalXYDataset
implements IntervalXYDataset, Cloneable, PublicCloneable, Serializable
A dataset that can be used for creating histograms.
See Also:
SimpleHistogramDataset

Constructor Summary

HistogramDataset()
Creates a new (empty) dataset with a default type of HistogramType.FREQUENCY.

Method Summary

void
addSeries(Comparable key, double[] values, int bins)
Adds a series to the dataset, using the specified number of bins.
void
addSeries(Comparable key, double[] values, int bins, double minimum, double maximum)
Adds a series to the dataset.
Object
clone()
Returns a clone of the dataset.
boolean
equals(Object obj)
Tests this dataset for equality with an arbitrary object.
Number
getEndX(int series, int item)
Returns the end value for a bin.
Number
getEndY(int series, int item)
Returns the end y-value for a bin (which is the same as the y-value, this method exists only to support the general form of the IntervalXYDataset interface).
int
getItemCount(int series)
Returns the number of data items for a series.
int
getSeriesCount()
Returns the number of series in the dataset.
Comparable
getSeriesKey(int series)
Returns the key for a series.
Number
getStartX(int series, int item)
Returns the start value for a bin.
Number
getStartY(int series, int item)
Returns the start y-value for a bin (which is the same as the y-value, this method exists only to support the general form of the IntervalXYDataset interface).
HistogramType
getType()
Returns the histogram type.
Number
getX(int series, int item)
Returns the X value for a bin.
Number
getY(int series, int item)
Returns the y-value for a bin (calculated to take into account the histogram type).
void
setType(HistogramType type)
Sets the histogram type and sends a DatasetChangeEvent to all registered listeners.

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

getEndXValue, getEndYValue, getStartXValue, getStartYValue

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

HistogramDataset

public HistogramDataset()
Creates a new (empty) dataset with a default type of HistogramType.FREQUENCY.

Method Details

addSeries

public void addSeries(Comparable key,
                      double[] values,
                      int bins)
Adds a series to the dataset, using the specified number of bins.
Parameters:
key - the series key (null not permitted).
values - the values (null not permitted).
bins - the number of bins (must be at least 1).

addSeries

public void addSeries(Comparable key,
                      double[] values,
                      int bins,
                      double minimum,
                      double maximum)
Adds a series to the dataset. Any data value less than minimum will be assigned to the first bin, and any data value greater than maximum will be assigned to the last bin. Values falling on the boundary of adjacent bins will be assigned to the higher indexed bin.
Parameters:
key - the series key (null not permitted).
values - the raw observations.
bins - the number of bins (must be at least 1).
minimum - the lower bound of the bin range.
maximum - the upper bound of the bin range.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of the dataset.
Overrides:
clone in interface AbstractDataset
Returns:
A clone of the dataset.

equals

public boolean equals(Object obj)
Tests this dataset for equality with an arbitrary object.
Parameters:
obj - the object to test against (null permitted).
Returns:
A boolean.

getEndX

public Number getEndX(int series,
                      int item)
Returns the end value for a bin.
Specified by:
getEndX in interface IntervalXYDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
item - the item index (zero based).
Returns:
The end value.

getEndY

public Number getEndY(int series,
                      int item)
Returns the end y-value for a bin (which is the same as the y-value, this method exists only to support the general form of the IntervalXYDataset interface).
Specified by:
getEndY in interface IntervalXYDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
item - the item index (zero based).
Returns:
The Y value.

getItemCount

public int getItemCount(int series)
Returns the number of data items for a 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 series key.

getStartX

public Number getStartX(int series,
                        int item)
Returns the start value for a bin.
Specified by:
getStartX in interface IntervalXYDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
item - the item index (zero based).
Returns:
The start value.

getStartY

public Number getStartY(int series,
                        int item)
Returns the start y-value for a bin (which is the same as the y-value, this method exists only to support the general form of the IntervalXYDataset interface).
Specified by:
getStartY in interface IntervalXYDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
item - the item index (zero based).
Returns:
The y-value.

getType

public HistogramType getType()
Returns the histogram type.
Returns:
The type (never null).

getX

public Number getX(int series,
                   int item)
Returns the X value for a bin. This value won't be used for plotting histograms, since the renderer will ignore it. But other renderers can use it (for example, you could use the dataset to create a line chart).
Specified by:
getX in interface XYDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
item - the item index (zero based).
Returns:
The start value.

getY

public Number getY(int series,
                   int item)
Returns the y-value for a bin (calculated to take into account the histogram type).
Specified by:
getY in interface XYDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
item - the item index (zero based).
Returns:
The y-value.

setType

public void setType(HistogramType type)
Sets the histogram type and sends a DatasetChangeEvent to all registered listeners.
Parameters:
type - the type (null not permitted).

Overview Package Class Use Source Tree Index Deprecated About