public class

HistogramDataset

extends AbstractIntervalXYDataset
implements Serializable Cloneable IntervalXYDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.AbstractIntervalXYDataset
           ↳ org.jfree.data.statistics.HistogramDataset

Class Overview

A dataset that can be used for creating histograms.

See Also

Summary

Public Constructors
HistogramDataset()
Creates a new (empty) dataset with a default type of HistogramType.FREQUENCY.
Public Methods
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.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractIntervalXYDataset
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.IntervalXYDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public HistogramDataset ()

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

Public Methods

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

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.

public Object clone ()

Returns a clone of the dataset.

Returns
  • A clone of the dataset.
Throws
CloneNotSupportedException if the object cannot be cloned.

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.

public Number getEndX (int series, int item)

Returns the end value for a bin.

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (zero based).
Returns
  • The end value.
Throws
IndexOutOfBoundsException if series is outside the specified range.

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

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (zero based).
Returns
  • The Y value.
Throws
IndexOutOfBoundsException if series is outside the specified range.

public int getItemCount (int series)

Returns the number of data items for a series.

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
Returns
  • The item count.
Throws
IndexOutOfBoundsException if series is outside 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 series key.
Throws
IndexOutOfBoundsException if series is outside the specified range.

public Number getStartX (int series, int item)

Returns the start value for a bin.

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (zero based).
Returns
  • The start value.
Throws
IndexOutOfBoundsException if series is outside the specified range.

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

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (zero based).
Returns
  • The y-value.
Throws
IndexOutOfBoundsException if series is outside the specified range.

public HistogramType getType ()

Returns the histogram type.

Returns
  • The type (never null).

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

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (zero based).
Returns
  • The start value.
Throws
IndexOutOfBoundsException if series is outside the specified range.

public Number getY (int series, int item)

Returns the y-value for a bin (calculated to take into account the histogram type).

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (zero based).
Returns
  • The y-value.
Throws
IndexOutOfBoundsException if series is outside the specified range.

public void setType (HistogramType type)

Sets the histogram type and sends a DatasetChangeEvent to all registered listeners.

Parameters
type the type (null not permitted).