datavisualizer.MerchValueDataRequest Class Reference

Produces a table of merchantable timber value results. More...

Inheritance diagram for datavisualizer.MerchValueDataRequest:

datavisualizer.DataRequest

List of all members.

Public Member Functions

 MerchValueDataRequest (String sChartName, DetailedOutputFileManager oManager) throws ModelException
 Constructor.
void AddGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal)
 This accepts the float data that holds merchantable value.
boolean WantAnyGridFloats ()
 This wants floats.
void AddGridFloatDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid float data member code for future reference when passed float data members.

Protected Member Functions

void WriteChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException
 Writes the table's data to tab-delimited text.

Package Functions

ModelInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws ModelException
 Creates a table of the results that have been collected.
void UpdateChart (Legend oLegend) throws ModelException
 Redraws the chart using the existing dataset.
void ClearData () throws ModelException
 Clears out existing data.

Private Member Functions

int GetSpeciesFromDataMemberLabel (String sLabel)
 Gets the species from a data member label which ends in "_x", where x is the species number.
JPanel CreateTable (Legend oLegend) throws ModelException
 Creates the results table.

Private Attributes

float[] mp_fValue
 The merchantable timber value for this timestep for each species.
int[] mp_iValueIndexes
 Translates a data member code to an index in the value array.
String[] mp_sColumnNames = {"Species", "Value/ha"}
 Table column headers.
String[] mp_sSpeciesNames
 Array of species names for display.
String m_sThisGrid
 Name of the grid from which the data will be collected.
float m_fPlotAreaInHectares
 Plot area, in hectares.
int m_iNumSpecies
 The number of species.
int m_iNumCols = 2
 Number of columns in the table.


Detailed Description

Produces a table of merchantable timber value results.

This requires the detailed output file to have data saved from the "Merchantable Timber Value" grid.

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

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
March 21, 2006: Created (LEM)

Constructor & Destructor Documentation

datavisualizer.MerchValueDataRequest.MerchValueDataRequest ( String  sChartName,
DetailedOutputFileManager  oManager 
) throws ModelException

Constructor.

Parameters:
sChartName Name of the chart
oManager Detailed output file manager
Exceptions:
ModelException not really, but I have to declare this.

Edit history:
------------------
March 21, 2006: Created (LEM)


Member Function Documentation

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

Writes the table'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.MerchValueDataRequest.AddGridFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal 
)

This accepts the float data that holds merchantable value.

The index vector is consulted and the values added to the appropriate array location.

Parameters:
sGridName Name of the grid for this data
iX X number of the cell from which this value came
iY Y number of the cell from which this value came
iCode Data member code of this value.
fVal Value.

Edit history:
------------------
March 21, 2006: Created (LEM)

Reimplemented from datavisualizer.DataRequest.

boolean datavisualizer.MerchValueDataRequest.WantAnyGridFloats (  ) 

This wants floats.

Returns:
True.

Reimplemented from datavisualizer.DataRequest.

void datavisualizer.MerchValueDataRequest.AddGridFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
)

Accepts a grid float data member code for future reference when passed float data members.

Parameters:
sGridName Name of the grid
sLabel The label of the data member.
iCode The data member code.

Edit history:
------------------
March 21, 2006: Created (LEM)

Reimplemented from datavisualizer.DataRequest.

int datavisualizer.MerchValueDataRequest.GetSpeciesFromDataMemberLabel ( String  sLabel  )  [private]

Gets the species from a data member label which ends in "_x", where x is the species number.

Parameters:
sLabel The data member label.
Returns:
The species number, or -1 if none exists.

Edit history:
------------------
March 21, 2006: Created (LEM)

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

Creates a table of the results that have been collected.

Parameters:
oLegend The species legend.
sChartTitle The chart title.
Returns:
A JInternalFrame with the table present in it.
Exceptions:
datavisualizer.ModelException 
Edit history:
------------------
March 21, 2006: Created (LEM)

Implements datavisualizer.DataRequest.

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

Redraws the chart using the existing dataset.

Parameters:
oLegend The legend for this chart.
Exceptions:
ModelException if anything goes wrong with the chart drawing.

Implements datavisualizer.DataRequest.

JPanel datavisualizer.MerchValueDataRequest.CreateTable ( Legend  oLegend  )  throws ModelException [private]

Creates the results table.

Parameters:
oLegend Legend for this chart.
Returns:
Panel containing the table.
Exceptions:
ModelException If anything goes wrong with the drawing.

Edit history:
------------------
March 21, 2006: Created (LEM)

void datavisualizer.MerchValueDataRequest.ClearData (  )  throws ModelException [package, virtual]

Clears out existing data.

Exceptions:
ModelException Doesn't throw an exception.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Implements datavisualizer.DataRequest.


Member Data Documentation

The merchantable timber value for this timestep for each species.

Translates a data member code to an index in the value array.

The code matches the location in these arrays; that location's value is the index to one of the above arrays.

String [] datavisualizer.MerchValueDataRequest.mp_sColumnNames = {"Species", "Value/ha"} [private]

Table column headers.

Putting them here makes them consistent in all possible display methods.

Array of species names for display.

Name of the grid from which the data will be collected.

Plot area, in hectares.

The number of species.

Number of columns in the table.


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