Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
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.SimpleHistogramDataset
public class SimpleHistogramDataset
extends AbstractIntervalXYDataset
implements IntervalXYDataset, Cloneable, PublicCloneable, Serializable
HistogramDataset
Constructor Summary | |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
void |
|
Object |
|
boolean |
|
boolean |
|
DomainOrder |
|
Number |
|
double |
|
Number |
|
double |
|
int |
|
int |
|
Comparable |
|
Number |
|
double |
|
Number |
|
double |
|
Number |
|
double |
|
Number |
|
double |
|
void |
|
void |
|
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 |
public SimpleHistogramDataset(Comparable key)
Creates a new histogram dataset. Note that theadjustForBinSize
flag defaults totrue
.
- Parameters:
key
- the series key (null
not permitted).
public void addBin(SimpleHistogramBin bin)
Adds a bin to the dataset. An exception is thrown if the bin overlaps with any existing bin in the dataset.
- Parameters:
bin
- the bin (null
not permitted).
- See Also:
removeAllBins()
public void addObservation(double value)
Adds an observation to the dataset (by incrementing the item count for the appropriate bin). A runtime exception is thrown if the value does not fit into any bin.
- Parameters:
value
- the value.
public void addObservation(double value, boolean notify)
Adds an observation to the dataset (by incrementing the item count for the appropriate bin). A runtime exception is thrown if the value does not fit into any bin.
- Parameters:
value
- the value.notify
- sendDatasetChangeEvent
to listeners?
public void addObservations(double[] values)
Adds a set of values to the dataset and sends aDatasetChangeEvent
to all registered listeners.
- Parameters:
values
- the values (null
not permitted).
- See Also:
clearObservations()
public void clearObservations()
Removes all current observation data and sends aDatasetChangeEvent
to all registered listeners.
- Since:
- 1.0.6
- See Also:
addObservations(double[])
,removeAllBins()
public Object clone() throws CloneNotSupportedException
Returns a clone of the dataset.
- Overrides:
- clone in interface AbstractDataset
- Returns:
- A clone.
public boolean equals(Object obj)
Compares the dataset for equality with an arbitrary object.
- Parameters:
obj
- the object (null
permitted).
- Returns:
- A boolean.
public boolean getAdjustForBinSize()
Returns a flag that controls whether or not the bin count is divided by the bin size in thegetXValue(int,int)
method.
- Returns:
- A boolean.
- See Also:
setAdjustForBinSize(boolean)
public DomainOrder getDomainOrder()
Returns the order of the domain (or X) values returned by the dataset.
- Specified by:
- getDomainOrder in interface XYDataset
- Overrides:
- getDomainOrder in interface AbstractXYDataset
- Returns:
- The order (never
null
).
public Number getEndX(int series, int item)
Returns the ending X value for the specified series and item.
- Specified by:
- getEndX in interface IntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The value.
public double getEndXValue(int series, int item)
Returns the end x-value (as a double primitive) for an item within a series.
- Specified by:
- getEndXValue in interface IntervalXYDataset
- Overrides:
- getEndXValue in interface AbstractIntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The end x-value.
public Number getEndY(int series, int item)
Returns the ending Y value for the specified series and item.
- Specified by:
- getEndY in interface IntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The value.
public double getEndYValue(int series, int item)
Returns the end y-value (as a double primitive) for an item within a series.
- Specified by:
- getEndYValue in interface IntervalXYDataset
- Overrides:
- getEndYValue in interface AbstractIntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The end y-value.
public int getItemCount(int series)
Returns the number of items in a series. Since this dataset only stores a single series, theseries
argument is ignored.
- Specified by:
- getItemCount in interface XYDataset
- Parameters:
series
- the series index (zero-based, ignored in this dataset).
- Returns:
- The item count.
public int getSeriesCount()
Returns the number of series in the dataset (always 1 for this dataset).
- Specified by:
- getSeriesCount in interface SeriesDataset
- Overrides:
- getSeriesCount in interface AbstractSeriesDataset
- Returns:
- The series count.
public Comparable getSeriesKey(int series)
Returns the key for a series. Since this dataset only stores a single series, theseries
argument is ignored.
- Specified by:
- getSeriesKey in interface SeriesDataset
- Overrides:
- getSeriesKey in interface AbstractSeriesDataset
- Parameters:
series
- the series (zero-based index, ignored in this dataset).
- Returns:
- The key for the series.
public Number getStartX(int series, int item)
Returns the starting X value for the specified series and item.
- Specified by:
- getStartX in interface IntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The value.
public double getStartXValue(int series, int item)
Returns the start x-value (as a double primitive) for an item within a series.
- Specified by:
- getStartXValue in interface IntervalXYDataset
- Overrides:
- getStartXValue in interface AbstractIntervalXYDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).
- Returns:
- The start x-value.
public Number getStartY(int series, int item)
Returns the starting Y value for the specified series and item.
- Specified by:
- getStartY in interface IntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The value.
public double getStartYValue(int series, int item)
Returns the start y-value (as a double primitive) for an item within a series.
- Specified by:
- getStartYValue in interface IntervalXYDataset
- Overrides:
- getStartYValue in interface AbstractIntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The start y-value.
public Number getX(int series, int item)
Returns the x-value for an item within a series. The x-values may or may not be returned in ascending order, that is up to the class implementing the interface.
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The x-value (never
null
).
public double getXValue(int series, int item)
Returns the x-value (as a double primitive) for an item within a series.
- Overrides:
- getXValue in interface AbstractXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The x-value.
public Number getY(int series, int item)
Returns the y-value for an item within a series.
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The y-value (possibly
null
).
public double getYValue(int series, int item)
Returns the y-value (as a double primitive) for an item within a series.
- Overrides:
- getYValue in interface AbstractXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).
- Returns:
- The y-value.
- See Also:
getAdjustForBinSize()
public void removeAllBins()
Removes all bins and sends aDatasetChangeEvent
to all registered listeners.
- Since:
- 1.0.6
- See Also:
addBin(SimpleHistogramBin)
public void setAdjustForBinSize(boolean adjust)
Sets the flag that controls whether or not the bin count is divided by the bin size in thegetYValue(int,int)
method, and sends aDatasetChangeEvent
to all registered listeners.
- Parameters:
adjust
- the flag.
- See Also:
getAdjustForBinSize()