datavisualizer.HistogramDataRequest Class Reference

This controls the drawing of a histogram for a single piece of information. More...

Inheritance diagram for datavisualizer.HistogramDataRequest:

datavisualizer.DataRequest

List of all members.

Public Member Functions

 HistogramDataRequest (String sLabel, boolean bIsFloat, DetailedOutputFileManager oManager, String sGraphName)
 Constructor.
void actionPerformed (ActionEvent oEvent)
 Performs actions for the controls in the Histogram window.
float GetBinSize ()
 Gets the bin size for this data request's histogram.
boolean GetUseLogarithmicAxis ()
 Gets whether or not to use a logarithmic axis.
void AddTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
 If the label matches the one given in the constructor, and the data being histogrammed is a float, this captures the values passed.
void AddTreeIntData (int iSpecies, int iType, int iCode, int iVal)
 This will add the integer data, if the data for this chart is an int that matches the data member code.
void AddTreeIntDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
 If the label matches the one given in the constructor, and the data being histogrammed is an int, this captures the values passed.
boolean WantAnyTreeInts ()
 If our data piece that's being graphed is an integer, this returns true.
boolean WantAnyTreeFloats ()
 If our data piece that's being graphed is a float, this returns true.
void AddTreeFloatData (int iSpecies, int iType, int iCode, float fVal)
 This will add the float data, if the data for this chart is a float that matches the data member code.

Protected Member Functions

void WriteChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException
 Writes the histogram's data to tab-delimited text.
ModelHistogramDataset UpdateForVisible (Legend oLegend) throws ModelException
 Copies our dataset and includes only species marked as visible in the legend.
void AddSeriesToDataset () throws ModelException
 This will add all series to the dataset.

Protected Attributes

ModelHistogramDataset m_oDataset
 The dataset that will be graphed.

Package Functions

ModelInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws ModelException
 Creates the histogram using data accumulated thus far.
void UpdateChart (Legend oLegend) throws ModelException
 Updates the histogram.
void ClearData ()
 This nulls our dataset and recreates it, and clears all of our data vectors.

Private Attributes

String m_sLabel
 Data member's label, as it appears in the detailed output file.
boolean m_bIsFloat
 Whether our data member being graphed is a float.
boolean m_bIsInt
 Whether our data member being graphed is an integer.
boolean m_bIncludeSnags = true
 Whether to include snags.
JTextField m_jNumBins = new JTextField("")
 Field displaying the number of bins in the histogram.
JTextField m_jBinSize = new JTextField("")
 Field displaying the bin size in the histogram.
int[][] mp_iDataMemberCodes
 The data member codes for this data member - one per species / type.
ArrayList< ArrayList< Number > > mp_oData
 The data - kept in an array of vectors - one per species.
ArrayList< ArrayList< Number > > mp_oSnagData
 The snag data (if it exists) - kept in an array of vectors - one per species.
float m_fPlotAreaInHectares
 Plot area in hectares.
float m_fBinSize
 Size of the histogram bins.
int m_iNumBins
 Number of bins in the histogram.
boolean m_bUseLogarithmicAxis
 Whether or not to use a logarithmic axis on the Y.
boolean m_bRecalcBinsOnUpdate
 Whether or not we have to recalculate the bins on chart update (i.e.
boolean m_bShowTotal = true
 Whether or not to display a total bar in each bin.


Detailed Description

This controls the drawing of a histogram for a single piece of information.

The label of the data is passed in the constructor. The histogram is defaulted to 10 divisions equally divided between their minimum and maximum values.

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)
July 19, 2004: Gave user bin control (LEM)
December 6, 2004: Added total bar (LEM)
February 7, 2008: Option to exclude snags, plus updating to conform to Java 6(LEM)

Constructor & Destructor Documentation

datavisualizer.HistogramDataRequest.HistogramDataRequest ( String  sLabel,
boolean  bIsFloat,
DetailedOutputFileManager  oManager,
String  sGraphName 
)

Constructor.

Parameters:
sLabel Label of the piece of data, as it would be passed as a data member code.
bIsFloat Whether this is float data. If this is set to false, integer data is assumed.
oManager The parent detailed output file manager.
sGraphName Name of graph string.


Member Function Documentation

void datavisualizer.HistogramDataRequest.WriteChartDataToFile ( java.io.FileWriter  jOut  )  throws java.io. IOException [protected, virtual]

Writes the histogram's data to tab-delimited text.

Parameters:
jOut java.io.FileWriter The file to write to.
Exceptions:
java.io.IOException if there's a problem writing the file.

Implements datavisualizer.DataRequest.

void datavisualizer.HistogramDataRequest.actionPerformed ( ActionEvent  oEvent  ) 

Performs actions for the controls in the Histogram window.

Parameters:
oEvent Event triggered.

float datavisualizer.HistogramDataRequest.GetBinSize (  ) 

Gets the bin size for this data request's histogram.

Returns:
The bin size.

boolean datavisualizer.HistogramDataRequest.GetUseLogarithmicAxis (  ) 

Gets whether or not to use a logarithmic axis.

Returns:
True if a logarithmic axis should be used, or false if a linear axis should be used.

void datavisualizer.HistogramDataRequest.AddTreeFloatDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
)

If the label matches the one given in the constructor, and the data being histogrammed is a float, this captures the values passed.

Parameters:
iSpecies Species for this data member
iType Type for this data member
sLabel Data member label.
iCode Data member code.

Reimplemented from datavisualizer.DataRequest.

ModelInternalFrame datavisualizer.HistogramDataRequest.DrawChart ( Legend  oLegend,
String  sChartTitle 
) throws ModelException [package, virtual]

Creates the histogram using data accumulated thus far.

Parameters:
oLegend Legend for this chart.
sChartTitle Title for this chart.
Returns:
The new chart window.
Exceptions:
datavisualizer.ModelException Passing through underlying exceptions.

Implements datavisualizer.DataRequest.

ModelHistogramDataset datavisualizer.HistogramDataRequest.UpdateForVisible ( Legend  oLegend  )  throws ModelException [protected]

Copies our dataset and includes only species marked as visible in the legend.

Parameters:
oLegend Legend for this chart.
Returns:
The copied dataset.
Exceptions:
ModelException Passing through an underlying exception.

void datavisualizer.HistogramDataRequest.UpdateChart ( Legend  oLegend  )  throws ModelException [package, virtual]

Updates the histogram.

Parameters:
oLegend Legend for this chart.
Exceptions:
datavisualizer.ModelException Passing through an underlying exception.

Implements datavisualizer.DataRequest.

void datavisualizer.HistogramDataRequest.AddSeriesToDataset (  )  throws ModelException [protected]

This will add all series to the dataset.

Exceptions:
ModelException Passing through from underlying

void datavisualizer.HistogramDataRequest.AddTreeIntData ( int  iSpecies,
int  iType,
int  iCode,
int  iVal 
)

This will add the integer data, if the data for this chart is an int that matches the data member code.

Parameters:
iSpecies Species for this data.
iType Type for this data. We don't care, other than for matching codes.
iCode Data member code.
iVal Value.

Reimplemented from datavisualizer.DataRequest.

void datavisualizer.HistogramDataRequest.AddTreeIntDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
)

If the label matches the one given in the constructor, and the data being histogrammed is an int, this captures the values passed.

Parameters:
iSpecies Species for this data member
iType Type for this data member
sLabel Data member label.
iCode Data member code.

Reimplemented from datavisualizer.DataRequest.

boolean datavisualizer.HistogramDataRequest.WantAnyTreeInts (  ) 

If our data piece that's being graphed is an integer, this returns true.

Otherwise, false.

Returns:
Whether this object's data piece is an integer.

Reimplemented from datavisualizer.DataRequest.

boolean datavisualizer.HistogramDataRequest.WantAnyTreeFloats (  ) 

If our data piece that's being graphed is a float, this returns true.

Otherwise, false.

Returns:
Whether this object's data piece is a float.

Reimplemented from datavisualizer.DataRequest.

void datavisualizer.HistogramDataRequest.ClearData (  )  [package, virtual]

This nulls our dataset and recreates it, and clears all of our data vectors.

Implements datavisualizer.DataRequest.

void datavisualizer.HistogramDataRequest.AddTreeFloatData ( int  iSpecies,
int  iType,
int  iCode,
float  fVal 
)

This will add the float data, if the data for this chart is a float that matches the data member code.

Parameters:
iSpecies Species for this data.
iType Type for this data. We don't care, other than for matching codes.
iCode Data member code.
fVal Value.

Reimplemented from datavisualizer.DataRequest.


Member Data Documentation

Data member's label, as it appears in the detailed output file.

Whether our data member being graphed is a float.

Whether our data member being graphed is an integer.

Whether to include snags.

The dataset that will be graphed.

JTextField datavisualizer.HistogramDataRequest.m_jNumBins = new JTextField("") [private]

Field displaying the number of bins in the histogram.

JTextField datavisualizer.HistogramDataRequest.m_jBinSize = new JTextField("") [private]

Field displaying the bin size in the histogram.

The data member codes for this data member - one per species / type.

ArrayList<ArrayList<Number> > datavisualizer.HistogramDataRequest.mp_oData [private]

The data - kept in an array of vectors - one per species.

ArrayList<ArrayList<Number> > datavisualizer.HistogramDataRequest.mp_oSnagData [private]

The snag data (if it exists) - kept in an array of vectors - one per species.

Plot area in hectares.

Size of the histogram bins.

Number of bins in the histogram.

Whether or not to use a logarithmic axis on the Y.

Whether or not we have to recalculate the bins on chart update (i.e.

we are charting an unknown data type without defaults)

Whether or not to display a total bar in each bin.


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

Generated on Wed Oct 28 14:01:17 2009 for SORTIE Java Interface by  doxygen 1.5.6