datavisualizer::StockTableDataRequest Class Reference

Writes a stock table for a detailed output file. More...

Inheritance diagram for datavisualizer::StockTableDataRequest:

datavisualizer::DataRequest List of all members.

Public Member Functions

 StockTableDataRequest (DetailedOutputFileManager oManager, String sChartName)
 Constructor.
void actionPerformed (java.awt.event.ActionEvent oEvent)
 Respons to the button clicks for this class's chart window.
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 WriteTables () throws javawrapper.ModelException
 This writes the tables.
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
 Does nothing unless the number of timesteps is different, in which case the table is recreated.
JInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws javawrapper.ModelException
 Draws the table.
void ClearData () throws javawrapper.ModelException
 Does nothing, because this table doesn't operate on the detailed output file timescale.

Private Member Functions

JPanel MakeTablePanel (int iSpecies) throws javawrapper.ModelException
 Makes a panel with a table for a species.
JPanel MakeSizeClassPanel ()
 Makes the panel containing the size class controls.

Private Attributes

DetailedOutputLegend m_oLegend = null
 The legend for the detailed output file whose data goes in the table.
Object[][][] mp_oTableData = null
 The data we will put into the table; species by rows by columns.
int[][] mp_iVolumeCode
 Holds the data codes for volume.
int[][] mp_iDbhCode
 Holds the data codes for DBH.
int[][] mp_iHeightCode
 Holds the data codes for height.
JTextField m_jNumSizeClasses = new JTextField("10")
 Field displaying the number of bins in the histogram.
JTextField m_jSizeClassSize = new JTextField("5.0")
 Field displaying the bin size in the histogram.
JComboBox m_jSpeciesBox
 Box that holds our species list.
String[] mp_sHeaders
 Column headers.
float[] mp_fSizeClasses
 List of size class upper boundaries.
float[][] mp_fTallestTrees
 Sorted list of the tallest trees, by species.
float m_fPlotAreaInHectares
 Area of the plot, in hectares.
float m_fNumYearsPerTimestep
 Number of years per timestep.
float[] mp_fTotalDBH
 Total of DBH, for calculating average, by species.
float[] mp_fNumDBH
 Number of DBHs added, for calculating average, by species.
float m_fSizeClassSize = (float) 5.0
 Size of DBH size classes, in cm.
float m_fDbh
 Current DBH value to be matched to volume.
float m_fVolume = -1
 Current volume value to be matched to DBH.
int m_iNumSpecies = -1
 Number of total species.
int m_iNumSizeClasses = 10
 Number of DBH size classes to display in table.
int m_iCurrentTimestep = -1
 The current timestep.
int m_iNumTimesteps = -1
 The total number of timesteps.
boolean m_bFirstTime = true
 So we can display the first time.

Detailed Description

Writes a stock table for a detailed output file.

The stock table displays volume data for a run as well as differences from the previous timestep. All values are displayed in cubic meters per hectare units. These values are broken up by size class as specified by the user. The tallest trees will also be included in the table if height was saved in the detailed output file.

This chart is different from other charts in that it displays data from all timesteps at once, instead of one timestep at a time. Thus, it tends to ignore normal chart drawing requests and has its own code to force parsing of all timestep files in a detailed output package at once.

Copyright: Copyright (c) Charles D. Canham 2003 Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
November 2, 2004: Created (LEM)
November 18, 2004: Updated for real-time data visualization (LEM)
June 14, 2005: Added mean DBH column (LEM)
March 23, 2006: Added species-specific tables (LEM)


Constructor & Destructor Documentation

datavisualizer::StockTableDataRequest::StockTableDataRequest 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:
------------------
November 2, 2004: Created (LEM)
March 23, 2006: Updated with species-specific stuff (LEM)


Member Function Documentation

void datavisualizer::StockTableDataRequest::actionPerformed java.awt.event.ActionEvent  oEvent  )  [inline]
 

Respons to the button clicks for this class's chart window.

Parameters:
oEvent ActionEvent Event to process.

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::StockTableDataRequest::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 either the density count (if m_iTableType = DENSITY) or the basal area total.

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:
------------------
November 2, 2004: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::StockTableDataRequest::AddTreeFloatDataMemberCode int  iSpecies,
int  iType,
String  sLabel,
int  iCode
[inline]
 

Accepts a tree float data member code.

We're looking for DBH and height.

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:
------------------
November 2, 2004: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::StockTableDataRequest::ClearData  )  throws javawrapper.ModelException [inline, package, virtual]
 

Does nothing, because this table doesn't operate on the detailed output file timescale.

Exceptions:
ModelException Won't throw it.

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

Implements datavisualizer::DataRequest.

JInternalFrame datavisualizer::StockTableDataRequest::DrawChart Legend  oLegend,
String  sChartTitle
throws javawrapper.ModelException [inline, package, virtual]
 

Draws the table.

Initially, there will be no table; just a place for a user to enter size class information.

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:
------------------
November 2, 2004: Created (LEM)

Implements datavisualizer::DataRequest.

JPanel datavisualizer::StockTableDataRequest::MakeSizeClassPanel  )  [inline, private]
 

Makes the panel containing the size class controls.

Returns:
JPanel Panel containing the size class controls.

JPanel datavisualizer::StockTableDataRequest::MakeTablePanel int  iSpecies  )  throws javawrapper.ModelException [inline, private]
 

Makes a panel with a table for a species.

Parameters:
iSpecies int iSpecies; if equal to m_iNumSpecies, shows the plot totals.
Returns:
JPanel Panel with the formatted table
Exceptions:
javawrapper.ModelException if there is an unrecognized species number

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

Does nothing unless the number of timesteps is different, in which case the table is recreated.

This chart does not respond to regular chart update events, since it already shows data for all timesteps.

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

Edit history:
------------------
November 2, 2004: Created (LEM)
November 18, 2004: Updated for real-time data visualization (LEM)

Implements datavisualizer::DataRequest.

boolean datavisualizer::StockTableDataRequest::WantAnyTreeFloats  )  [inline]
 

This wants diameter values for all trees.

Returns:
boolean Set to true.

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

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::StockTableDataRequest::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 2, 2004: Submitted in beta version (LEM)

Implements datavisualizer::DataRequest.

void datavisualizer::StockTableDataRequest::WriteTables  )  throws javawrapper.ModelException [inline, protected]
 

This writes the tables.

It forces the DetailedOutputFileManager to move through each timestep so the data can be collected. Then it formats the table into the chart window.

Exceptions:
ModelException if there is a problem parsing the data.


Member Data Documentation

int datavisualizer::StockTableDataRequest::m_iCurrentTimestep = -1 [private]
 

The current timestep.

This helps process an entire detailed output file. It also lets this class know when to ignore offered data - whenever this value is set to -1, some other chart event triggered the parse.

int datavisualizer::StockTableDataRequest::m_iNumTimesteps = -1 [private]
 

The total number of timesteps.

We keep track of this so we know if something has changed (as in real-time data visualization) so we can update appropriately.

float [] datavisualizer::StockTableDataRequest::mp_fSizeClasses [private]
 

List of size class upper boundaries.

Sized m_iNumSizeClasses.

int [][] datavisualizer::StockTableDataRequest::mp_iDbhCode [private]
 

Holds the data codes for DBH.

Array indexes are #1 - type and #2 - species.

int [][] datavisualizer::StockTableDataRequest::mp_iHeightCode [private]
 

Holds the data codes for height.

Array indexes are #1 - type and #2 - species.

int [][] datavisualizer::StockTableDataRequest::mp_iVolumeCode [private]
 

Holds the data codes for volume.

Array indexes are #1 - type and #2 - species.


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 15:15:28 2006 for SORTIE Java Interface by  doxygen 1.4.6-NO