SORTIE Java Interface  1
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
sortie.datavisualizer.HarvestDataRequest Class Reference

Produces a table of harvest or mortality episode results. More...

Inheritance diagram for sortie.datavisualizer.HarvestDataRequest:
sortie.datavisualizer.DataRequest

Public Member Functions

 HarvestDataRequest (String sChartName, DetailedOutputFileManager oManager) throws ModelException
 Constructor. More...
 
void addGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal, boolean bBatchMode)
 If this is from a Results grid, it is assumed to be a basal area value. More...
 
void addGridIntData (String sGridName, int iX, int iY, int iCode, int iVal, boolean bBatchMode)
 If this is from a Results grid, it is assumed to be a density value. More...
 
boolean wantAnyGridFloats ()
 This wants floats. More...
 
boolean wantAnyGridInts ()
 This wants ints. More...
 
void addGridFloatDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid float data member code for future reference when passed float data members. More...
 
void addGridIntDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid int data member code for future reference when passed int data members. More...
 
void getReadyForTimestepParse (int iTimestep, boolean bBatchMode) throws ModelException
 Clears out existing data. More...
 
- Public Member Functions inherited from sortie.datavisualizer.DataRequest
 DataRequest (String sChartName, DetailedOutputFileManager oManager)
 Constructor. More...
 
void setCurrentTimestep (int iTimestep)
 Sets the current time step. More...
 
void actionPerformed (java.awt.event.ActionEvent oEvent)
 If passed the order to write chart data, does it. More...
 
void extractBatchSetupInfo (ChartInfo oInfo) throws ModelException
 Extracts information needed by the data request from the controls panel displayed to the user. More...
 
boolean isFileWritingExternallyManaged ()
 Gets whether or not file writing is externally managed for this data request or whether it takes care of everything itself. More...
 
void getReadyForTimestepParse (int iTimestep, boolean bBatchMode) throws ModelException
 This will be called for all open data requests just before time step parsing begins. More...
 
void timestepParseFinished (boolean bBatchMode) throws ModelException
 This will be called for all open data requests after time step parsing is completed. More...
 
void outputFileParseFinished (boolean bBatchMode)
 This will be called for all open data requests after output file parsing is completed. More...
 
void saveChartDataToFile (boolean bJustCurrTS)
 Writes a chart's data to a file. More...
 
String getChartName ()
 Get the name of the chart. More...
 
JInternalFrame getChart ()
 Get the chart frame. More...
 
boolean wantAnyTreeFloats ()
 Whether or not this object wants any tree float data members. More...
 
boolean wantAnyTreeInts ()
 Whether or not this object wants any tree int data members. More...
 
boolean wantAnyTreeChars ()
 Whether or not this object wants any tree char data members. More...
 
boolean wantAnyTreeBools ()
 Whether or not this object wants any tree bool data members. More...
 
boolean wantAnyDeadTreeFloats ()
 Whether or not this object wants any dead tree float data members. More...
 
boolean wantAnyDeadTreeInts ()
 Whether or not this object wants any dead tree int data members. More...
 
boolean wantAnyDeadTreeChars ()
 Whether or not this object wants any dead tree char data members. More...
 
boolean wantAnyDeadTreeBools ()
 Whether or not this object wants any dead tree bool data members. More...
 
boolean wantAnyGridFloats ()
 Whether or not this object wants any grid float data members. More...
 
boolean wantAnyGridInts ()
 Whether or not this object wants any grid int data members. More...
 
boolean wantAnyGridChars ()
 Whether or not this object wants any grid char data members. More...
 
boolean wantAnyGridBools ()
 Whether or not this object wants any grid bool data members. More...
 
boolean wantAnyGridPackageFloats ()
 Whether or not this object wants any grid package float data members. More...
 
boolean wantAnyGridPackageInts ()
 Whether or not this object wants any grid package int data members. More...
 
boolean wantAnyGridPackageChars ()
 Whether or not this object wants any grid package char data members. More...
 
boolean wantAnyGridPackageBools ()
 Whether or not this object wants any grid package bool data members. More...
 
void addTreeFloatData (int iSpecies, int iType, int iCode, float fVal, boolean bBatchMode) throws SAXException
 Accepts a piece of tree float data from the parser. More...
 
void addTreeIntData (int iSpecies, int iType, int iCode, int iVal, boolean bBatchMode) throws SAXException
 Accepts a piece of tree int data from the parser. More...
 
void addTreeCharData (int iSpecies, int iType, int iCode, String sVal, boolean bBatchMode) throws SAXException
 Accepts a piece of tree char data from the parser. More...
 
void addTreeBoolData (int iSpecies, int iType, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
 Accepts a piece of tree bool data from the parser. More...
 
void addDeadTreeFloatData (int iSpecies, int iType, int iCode, int iDeadCode, float fVal, boolean bBatchMode) throws SAXException
 Accepts a piece of dead tree float data from the parser. More...
 
void addDeadTreeIntData (int iSpecies, int iType, int iCode, int iDeadCode, int iVal, boolean bBatchMode) throws SAXException
 Accepts a piece of dead tree int data from the parser. More...
 
void addDeadTreeCharData (int iSpecies, int iType, int iCode, int iDeadCode, String sVal, boolean bBatchMode) throws SAXException
 Accepts a piece of dead tree char data from the parser. More...
 
void addDeadTreeBoolData (int iSpecies, int iType, int iCode, int iDeadCode, boolean bVal, boolean bBatchMode) throws SAXException
 Accepts a piece of dead tree bool data from the parser. More...
 
void addGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal, boolean bBatchMode) throws SAXException
 Accepts a piece of grid float data from the parser. More...
 
void addGridIntData (String sGridName, int iX, int iY, int iCode, int iVal, boolean bBatchMode) throws SAXException
 Accepts a piece of grid int data from the parser. More...
 
void addGridCharData (String sGridName, int iX, int iY, int iCode, String sVal, boolean bBatchMode) throws SAXException
 Accepts a piece of grid char data from the parser. More...
 
void addGridBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
 Accepts a piece of grid bool data from the parser. More...
 
void addGridPackageFloatData (String sGridName, int iX, int iY, int iCode, float fVal, boolean bBatchMode) throws SAXException
 Accepts a piece of grid package float data from the parser. More...
 
void addGridPackageIntData (String sGridName, int iX, int iY, int iCode, int iVal, boolean bBatchMode) throws SAXException
 Accepts a piece of grid package int data from the parser. More...
 
void addGridPackageCharData (String sGridName, int iX, int iY, int iCode, String sVal, boolean bBatchMode) throws SAXException
 Accepts a piece of grid package char data from the parser. More...
 
void addGridPackageBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
 Accepts a piece of grid package bool data from the parser. More...
 
void endPackage () throws SAXException
 Announces a package has ended. More...
 
void endTree (boolean bBatchMode) throws SAXException
 Announces a tree record has ended. More...
 
void addTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
 Accepts a tree float data member code for future reference when passed float data members. More...
 
void addTreeIntDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
 Accepts a tree int data member code for future reference when passed int data members. More...
 
void addTreeCharDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
 Accepts a tree char data member code for future reference when passed char data members. More...
 
void addTreeBoolDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
 Accepts a tree bool data member code for future reference when passed bool data members. More...
 
void addGridFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid float data member code for future reference when passed float data members. More...
 
void addGridIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid int data member code for future reference when passed int data members. More...
 
void addGridCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid char data member code for future reference when passed char data members. More...
 
void addGridBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid bool data member code for future reference when passed bool data members. More...
 
void addGridPackageFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid package float data member code for future reference when passed float data members. More...
 
void addGridPackageIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid package int data member code for future reference when passed int data members. More...
 
void addGridPackageCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid package char data member code for future reference when passed char data members. More...
 
void addGridPackageBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid package bool data member code for future reference when passed bool data members. More...
 

Protected Member Functions

void writeChartDataToFile (FileWriter jOut) throws IOException
 Writes the table's data to tab-delimited text. More...
 
- Protected Member Functions inherited from sortie.datavisualizer.DataRequest
abstract void writeChartDataToFile (java.io.FileWriter jOut) throws java.io.IOException, ModelException
 Child classes override this to write the data behind their chart to tab-delimited text. More...
 

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. More...
 
JPanel createTable (Legend oLegend) throws ModelException
 Creates the results table. More...
 

Private Attributes

float [] mp_fDensity
 The density cut for this timestep for each species. More...
 
float [] mp_fBasalArea
 The basal area cut for this timestep for each species. More...
 
float [] mp_fSeedlingDensity
 The seedling density cut for this timestep for each species. More...
 
int [] mp_iDensityIndexes
 Translates a data member code to an index in the density array. More...
 
boolean [] mp_bIsSeedlingDensity
 
int [] mp_iBasalAreaIndexes
 Translates a data member code to an index in the basal area array. More...
 
String [] mp_sColumnNames
 Column headers, to be consistent between displays. More...
 
String [] mp_sSpeciesNames
 Keep our species names ready to display, as well. More...
 
String m_sThisGrid
 Name of the grid from which the data will be collected. More...
 
float m_fPlotAreaInHectares
 Plot area, in hectares. More...
 
int m_iNumSpecies
 The number of species. More...
 

Additional Inherited Members

- Protected Attributes inherited from sortie.datavisualizer.DataRequest
String m_sBatchFilename = ""
 File name for batch data extraction. More...
 
int m_iCurrentTimestep
 Current time step being parsed. More...
 
boolean m_bShowOneTimestep = true
 Whether this chart shows one timestep at a time (true) or all timesteps (false). More...
 
boolean m_bExternallyManageWriting = true
 Whether or not this data request gets its file writing managed externally. More...
 
ModelInternalFrame m_oChartFrame
 Chart for this request. More...
 
String m_sChartName
 Name string of chart. More...
 

Detailed Description

Produces a table of harvest or mortality episode results.

A harvest table requires the detailed output file to have data saved from the "Harvest Results" grid; for mortality episodes, the "Mortality Episode Results" grid.

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

Author
Lora E. Murphy
Version
1.0


Edit history:
---------------—
December 8, 2011: Wiped the slate clean for version 7 (LEM)

Constructor & Destructor Documentation

◆ HarvestDataRequest()

sortie.datavisualizer.HarvestDataRequest.HarvestDataRequest ( String  sChartName,
DetailedOutputFileManager  oManager 
) throws ModelException

Constructor.

Parameters
sChartNameName of the chart
oManagerDetailed output file manager
Exceptions
ModelExceptionnot really, but I have to declare this.

Member Function Documentation

◆ addGridFloatData()

void sortie.datavisualizer.HarvestDataRequest.addGridFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal,
boolean  bBatchMode 
)

If this is from a Results grid, it is assumed to be a basal area value.

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

Parameters
sGridNameName of the grid for this data
iXX number of the cell from which this value came
iYY number of the cell from which this value came
iCodeData member code of this value.
fValValue.
bBatchModeWhether or not we're in batch mode.

◆ addGridFloatDataMemberCode()

void sortie.datavisualizer.HarvestDataRequest.addGridFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
)

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

Parameters
sGridNameName of the grid
sLabelThe label of the data member.
iCodeThe data member code.

◆ addGridIntData()

void sortie.datavisualizer.HarvestDataRequest.addGridIntData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal,
boolean  bBatchMode 
)

If this is from a Results grid, it is assumed to be a density value.

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

Parameters
sGridNameName of the grid for this data
iXX number of the cell from which this value came
iYY number of the cell from which this value came
iCodeData member code of this value.
iValValue.
bBatchModeWhether or not we're in batch mode.

◆ addGridIntDataMemberCode()

void sortie.datavisualizer.HarvestDataRequest.addGridIntDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
)

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

Parameters
sGridNameName of the grid
sLabelThe label of the data member.
iCodeThe data member code.

◆ createTable()

JPanel sortie.datavisualizer.HarvestDataRequest.createTable ( Legend  oLegend) throws ModelException
private

Creates the results table.

Parameters
oLegendLegend for this chart.
Returns
Panel containing the table.
Exceptions
ModelExceptionIf anything goes wrong with the drawing.

◆ getReadyForTimestepParse()

void sortie.datavisualizer.HarvestDataRequest.getReadyForTimestepParse ( int  iTimestep,
boolean  bBatchMode 
) throws ModelException

Clears out existing data.

Exceptions
ModelExceptionDoesn't throw an exception.

◆ getSpeciesFromDataMemberLabel()

int sortie.datavisualizer.HarvestDataRequest.getSpeciesFromDataMemberLabel ( String  sLabel)
private

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

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

◆ wantAnyGridFloats()

boolean sortie.datavisualizer.HarvestDataRequest.wantAnyGridFloats ( )

This wants floats.

Returns
True.

◆ wantAnyGridInts()

boolean sortie.datavisualizer.HarvestDataRequest.wantAnyGridInts ( )

This wants ints.

Returns
True.

◆ writeChartDataToFile()

void sortie.datavisualizer.HarvestDataRequest.writeChartDataToFile ( FileWriter  jOut) throws IOException
protected

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

Parameters
jOutFileWriter The file to write to.
Exceptions
IOExceptionif there's a problem writing the file.

Member Data Documentation

◆ m_fPlotAreaInHectares

float sortie.datavisualizer.HarvestDataRequest.m_fPlotAreaInHectares
private

Plot area, in hectares.

◆ m_iNumSpecies

int sortie.datavisualizer.HarvestDataRequest.m_iNumSpecies
private

The number of species.

◆ m_sThisGrid

String sortie.datavisualizer.HarvestDataRequest.m_sThisGrid
private

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

◆ mp_bIsSeedlingDensity

boolean [] sortie.datavisualizer.HarvestDataRequest.mp_bIsSeedlingDensity
private

◆ mp_fBasalArea

float [] sortie.datavisualizer.HarvestDataRequest.mp_fBasalArea
private

The basal area cut for this timestep for each species.

◆ mp_fDensity

float [] sortie.datavisualizer.HarvestDataRequest.mp_fDensity
private

The density cut for this timestep for each species.

◆ mp_fSeedlingDensity

float [] sortie.datavisualizer.HarvestDataRequest.mp_fSeedlingDensity
private

The seedling density cut for this timestep for each species.

◆ mp_iBasalAreaIndexes

int [] sortie.datavisualizer.HarvestDataRequest.mp_iBasalAreaIndexes
private

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

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

◆ mp_iDensityIndexes

int [] sortie.datavisualizer.HarvestDataRequest.mp_iDensityIndexes
private

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

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

◆ mp_sColumnNames

String [] sortie.datavisualizer.HarvestDataRequest.mp_sColumnNames
private
Initial value:
= {
"Species", "Density (#/ha)", "Basal Area (sq. m/ha)",
"Seedling Density (#/ha)"}

Column headers, to be consistent between displays.

◆ mp_sSpeciesNames

String [] sortie.datavisualizer.HarvestDataRequest.mp_sSpeciesNames
private

Keep our species names ready to display, as well.


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