datavisualizer.ModelHistogramDataset Class Reference

This is a hack of the HistogramDataset in JFreeChart. More...

Inherits org::jfree::data::xy::AbstractIntervalXYDataset, and org::jfree::data::xy::IntervalXYDataset.

List of all members.

Public Member Functions

void addSeries (String sName, float[] p_fValues, int iNumberOfBins, float fBinSize)
 Adds a series.
void AddTotalSeries ()
 Adds a series that is, for each bin, a total of the values of all other series' values in that bin.
int getSeriesCount ()
 Returns the number of series in the dataset.
Comparable< String > getSeriesKey (int series)
 Returns the name for a series.
int getItemCount (int series)
 Returns the number of data items for a series.
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.
void setYValue (int series, int item, float iValue)
 Sets the Y value for a bin.
Number getStartX (int series, int item)
 Returns the start value for a bin.
Number getEndX (int series, int item)
 Returns the end value for a bin.
Number getStartY (int series, int item)
 Returns the Y value for a bin.
Number getEndY (int series, int item)
 Returns the Y value for a bin.
void RemoveSeries (int series)
 I added this.
Object clone ()
 I added this.

Static Package Attributes

static final long serialVersionUID = 1

Private Member Functions

HistogramBin[] getBins (int series)
 Returns the bins for a series.
float getBinWidth (int series)
 Returns the total for a series.

Private Attributes

List< Map< String, Object > > list = new ArrayList<Map<String, Object>>()
 Histogram list.


Detailed Description

This is a hack of the HistogramDataset in JFreeChart.

It did not suit my needs - particularly the ability to modify series. So I've made my own.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Member Function Documentation

void datavisualizer.ModelHistogramDataset.addSeries ( String  sName,
float[]  p_fValues,
int  iNumberOfBins,
float  fBinSize 
)

Adds a series.

Parameters:
sName the series name.
p_fValues the values (null not permitted).
iNumberOfBins the number of bins (must be at least 1).
fBinSize the size of the bins.

void datavisualizer.ModelHistogramDataset.AddTotalSeries (  ) 

Adds a series that is, for each bin, a total of the values of all other series' values in that bin.

HistogramBin [] datavisualizer.ModelHistogramDataset.getBins ( int  series  )  [private]

Returns the bins for a series.

Parameters:
series the series index.
Returns:
An array of bins.

float datavisualizer.ModelHistogramDataset.getBinWidth ( int  series  )  [private]

Returns the total for a series.

Parameters:
series the series index.
Returns:
The total. Returns the bin width for a series.
Parameters:
series the series index (zero based).
Returns:
The bin width.

int datavisualizer.ModelHistogramDataset.getSeriesCount (  ) 

Returns the number of series in the dataset.

Returns:
The series count.

Comparable<String> datavisualizer.ModelHistogramDataset.getSeriesKey ( int  series  ) 

Returns the name for a series.

Parameters:
series the series index (zero based).
Returns:
The series name.

int datavisualizer.ModelHistogramDataset.getItemCount ( int  series  ) 

Returns the number of data items for a series.

Parameters:
series the series index (zero based).
Returns:
The item count.

Number datavisualizer.ModelHistogramDataset.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 (zero based).
item the item index (zero based).
Returns:
The start value.

Number datavisualizer.ModelHistogramDataset.getY ( int  series,
int  item 
)

Returns the Y value for a bin.

Parameters:
series the series index (zero based).
item the item index (zero based) - i.e. bin number.
Returns:
The Y value.

void datavisualizer.ModelHistogramDataset.setYValue ( int  series,
int  item,
float  iValue 
)

Sets the Y value for a bin.

Added by Lora to allow for adjusting values to be per hectare.

Parameters:
series the series index (zero based).
item the item index (zero based).
iValue the new value to set.

Number datavisualizer.ModelHistogramDataset.getStartX ( int  series,
int  item 
)

Returns the start value for a bin.

Parameters:
series the series index (zero based).
item the item index (zero based).
Returns:
The start value.

Number datavisualizer.ModelHistogramDataset.getEndX ( int  series,
int  item 
)

Returns the end value for a bin.

Parameters:
series the series index (zero based).
item the item index (zero based).
Returns:
The end value.

Number datavisualizer.ModelHistogramDataset.getStartY ( int  series,
int  item 
)

Returns the Y value for a bin.

Parameters:
series the series index (zero based).
item the item index (zero based).
Returns:
The Y value.

Number datavisualizer.ModelHistogramDataset.getEndY ( int  series,
int  item 
)

Returns the Y value for a bin.

Parameters:
series the series index (zero based).
item the item index (zero based).
Returns:
The Y value.

void datavisualizer.ModelHistogramDataset.RemoveSeries ( int  series  ) 

I added this.

I wanted to be able to remove a series.

Parameters:
series The series index (zero based).

Object datavisualizer.ModelHistogramDataset.clone (  ) 

I added this.

This creates a deep-enough clone of the dataset. The array list is cloned but not the underlying values - it is enough to be able to remove references in the clone. I don't need it deeper, so I didn't write it deeper.

Returns:
The clone.


Member Data Documentation

List<Map<String, Object> > datavisualizer.ModelHistogramDataset.list = new ArrayList<Map<String, Object>>() [private]

Histogram list.


The documentation for this class was generated from the following file:

Generated on Tue Apr 19 13:59:33 2011 for SORTIE Java Interface by  doxygen 1.5.6