org.jfree.data.statistics

Class HistogramDataset

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
voidaddSeries(Comparable key, double[] values, int bins)
Adds a series to the dataset, using the specified number of bins.
voidaddSeries(Comparable key, double[] values, int bins, double minimum, double maximum)
Adds a series to the dataset.
Objectclone()
Returns a clone of the dataset.
booleanequals(Object obj)
Tests this dataset for equality with an arbitrary object.
NumbergetEndX(int series, int item)
Returns the end value for a bin.
NumbergetEndY(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).
intgetItemCount(int series)
Returns the number of data items for a series.
intgetSeriesCount()
Returns the number of series in the dataset.
ComparablegetSeriesKey(int series)
Returns the key for a series.
NumbergetStartX(int series, int item)
Returns the start value for a bin.
NumbergetStartY(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).
HistogramTypegetType()
Returns the histogram type.
NumbergetX(int series, int item)
Returns the X value for a bin.
NumbergetY(int series, int item)
Returns the y-value for a bin (calculated to take into account the histogram type).
voidsetType(HistogramType type)
Sets the histogram type and sends a DatasetChangeEvent to all registered listeners.

Constructor Detail

HistogramDataset

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

Method Detail

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()
Returns a clone of the dataset.

Returns: A clone of the dataset.

Throws: CloneNotSupportedException if the object cannot be cloned.

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.

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.

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

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.

getItemCount

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.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the dataset.

Returns: The series count.

getSeriesKey

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.

getStartX

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.

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

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.

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

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.

getY

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.

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

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