datavisualizer::OverviewTableDataRequest Class Reference

Writes an overview table for a detailed output file (basal area and density for each life history stage). More...

Inheritance diagram for datavisualizer::OverviewTableDataRequest:

datavisualizer::DataRequest List of all members.

Public Member Functions

 OverviewTableDataRequest (DetailedOutputFileManager oManager, String sChartName)
 Constructor.
boolean WantAnyTreeFloats ()
 This wants diameter values for all trees.
void AddTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
 Accepts a tree float data member code.
void AddTreeFloatData (int iSpecies, int iType, int iCode, float fVal)
 Accepts a tree float data member value.

Protected Member Functions

void WriteChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException
 Saves the data in the current table as a tab-delimited text file.

Package Functions

void UpdateChart (Legend oLegend) throws javawrapper.ModelException
 Causes the table to refresh its data.
ModelInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws javawrapper.ModelException
 Draws the table.
void ClearData ()
 Sets all the values in the data collection arrays back to 0.

Detailed Description

Writes an overview table for a detailed output file (basal area and density for each life history stage).

The tabulation of density and basal area data is based on the diameter value for each tree life history stage (that is, diameter at 10 cm for seedlings and DBH for everything else). For density, the number of diameter values encountered is counted; for basal area, the individual basal areas calculated from DBH are totaled. All values are displayed in per hectare units.

Technically, density data could be extracted from any tree data member, since counting up the total is all that is required. I didn't do it that way because I'm a little lazy, and I'll wait for a hue and cry from the users before unnecessarily complicating my code.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
August 4, 2004: Created (LEM)


Constructor & Destructor Documentation

datavisualizer::OverviewTableDataRequest::OverviewTableDataRequest ( DetailedOutputFileManager  oManager,
String  sChartName 
) [inline]

Constructor.

Declares all the arrays.

Parameters:
oManager Parent detailed output file manager
sChartName Name of the table being drawn.

Edit history:
------------------
August 4, 2004: Created (LEM)


Member Function Documentation

void datavisualizer::OverviewTableDataRequest::UpdateChart ( Legend  oLegend  )  throws javawrapper.ModelException [inline, package, virtual]

Causes the table to refresh its data.

Parameters:
oLegend Legend The legend for this chart.
Exceptions:
ModelException Won't be thrown.

Edit history:
------------------
August 4, 2004: Created (LEM)

Implements datavisualizer::DataRequest.

ModelInternalFrame datavisualizer::OverviewTableDataRequest::DrawChart ( Legend  oLegend,
String  sChartTitle 
) throws javawrapper.ModelException [inline, package, virtual]

Draws the table.

Parameters:
oLegend Legend Legend for this chart.
sChartTitle String Chart name for the window title.
Exceptions:
ModelException Passed through from other called methods - this method doesn't throw it.
Returns:
JInternalFrame The finished chart window.

Edit history:
------------------
August 4, 2004: Created (LEM)

Implements datavisualizer::DataRequest.

void datavisualizer::OverviewTableDataRequest::ClearData (  )  [inline, package, virtual]

Sets all the values in the data collection arrays back to 0.


Edit history:
------------------
August 4, 2004: Created (LEM)

Implements datavisualizer::DataRequest.

boolean datavisualizer::OverviewTableDataRequest::WantAnyTreeFloats (  )  [inline]

This wants diameter values for all trees.

Returns:
boolean Set to true.

Edit history:
------------------
August 4, 2004: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::OverviewTableDataRequest::AddTreeFloatDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) [inline]

Accepts a tree float data member code.

We're looking for diam10 for seedlings, and DBH for all other tree types supported.

Parameters:
iSpecies The species for which this is a data member.
iType The tree type for which this is a data member.
sLabel The label of the data member.
iCode The data member code.

Edit history:
------------------
August 4, 2004: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::OverviewTableDataRequest::AddTreeFloatData ( int  iSpecies,
int  iType,
int  iCode,
float  fVal 
) [inline]

Accepts a tree float data member value.

If it matches our code, we'll increment the density count and the basal area total, if it's bigger than a seedling.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
iCode Data member code of this value.
fVal Value.

Edit history:
------------------
August 4, 2004: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

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

Saves the data in the current table as a tab-delimited text file.

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

Edit history:
------------------
November 12, 2004: Created (LEM)

Implements datavisualizer::DataRequest.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:52 2007 for SORTIE Java Interface by  doxygen 1.5.2