datavisualizer.TreeMapCrownRadDataRequest Class Reference

This class manages the data for, and draws, tree maps. More...

Inheritance diagram for datavisualizer.TreeMapCrownRadDataRequest:

datavisualizer.DataRequest

List of all members.

Public Member Functions

 TreeMapCrownRadDataRequest (DetailedOutputFileManager oManager, String sChartName) throws ModelException
 Constructor.
void SetMinimumCrownRadius (float f)
 Sets the minimum crown radius value to show on the map.
float GetMinimumCrownRadius ()
 Gets the minimum crown radius value to show on the map.
boolean WantAnyTreeFloats ()
 Whether or not this object wants any tree float data members.
void AddTreeFloatData (int iSpecies, int iType, int iCode, float fVal)
 Accepts a piece of tree float data from the parser.
void AddTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
 Accepts a tree float data member code for future reference when passed float data members.
void UpdateChart (Legend oLegend) throws ModelException
 Updates the tree map.
void actionPerformed (java.awt.event.ActionEvent oEvent)
 Performs actions for the controls in the Histogram window.
void SaveChartDataToFile (boolean bJustCurrTS)
 Writes a chart's data to a file.

Protected Member Functions

void WriteChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException, javawrapper.ModelException
 Writes the tree map's data to tab-delimited text.
DefaultXYZDataset UpdateForVisible (Legend oLegend, DefaultXYZDataset oDatasetToAdjust) throws ModelException
 Returns a copy of the dataset with only those species which are marked as visible in the legend.
void RestoreOriginalView ()
 Restores the original view of the tree map with the scale at which it was first displayed.
void Scroll (int iDirection)
 Scrolls the view 10% in the specified direction.

Package Functions

void ClearData () throws ModelException
 Clears out data for garbage collection in preparation for new data being read in.
ModelInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws ModelException
 Creates the tree map window.

Private Attributes

Vector< Vector< XYZDataItem > > mp_oSeries
 A vector of XYZDataItems, one for each species.
JTextField m_jMinCrownRad = new JTextField("")
 Field displaying the minimum crown radius.
int[][] mp_iXCode
 Holds the data codes for X.
int[][] mp_iYCode
 Holds the data codes for Y.
int[][] mp_iCrownRadCode
 Holds the data codes for crown radius .
float m_fX
 Tree X coordinate.
float m_fY
 Tree Y coordinate.
float m_fCrownRad
 Tree crown radius value.
float m_fMinCrownRad
 Minimum crown radius to draw.
int m_iNumSpecies
 Total number of species.
int m_iNumTypes
 Total number of tree types.
ChartPanel m_oChartPanel = null
 Chart being displayed.

Static Private Attributes

static final int LEFT = 1
 Scrolling left.
static final int RIGHT = 2
 Scrolling right.
static final int UP = 3
 Scrolling up.
static final int DOWN = 4
 Scrolling down.


Detailed Description

This class manages the data for, and draws, tree maps.

Seedlings are not drawn. Unlike with the DBH map, crown radius will not be scaled. This means that crown radius geometries can accurately be judged.

X, Y, and Crown Radius are required to draw a tree map.

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

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 24, 2009: Created (LEM)

Constructor & Destructor Documentation

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

Constructor.

Parameters:
oManager Parent detailed output file manager
sChartName Chart name
Exceptions:
ModelException Passing through possible underlying exceptions


Member Function Documentation

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

Writes the tree map's data to tab-delimited text.

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

Implements datavisualizer.DataRequest.

void datavisualizer.TreeMapCrownRadDataRequest.SetMinimumCrownRadius ( float  f  ) 

Sets the minimum crown radius value to show on the map.

Parameters:
f The new minimum.

float datavisualizer.TreeMapCrownRadDataRequest.GetMinimumCrownRadius (  ) 

Gets the minimum crown radius value to show on the map.

Returns:
The minimum crown radius value.

boolean datavisualizer.TreeMapCrownRadDataRequest.WantAnyTreeFloats (  ) 

Whether or not this object wants any tree float data members.

Returns:
True if float data members are desired, false if not.

Reimplemented from datavisualizer.DataRequest.

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

Clears out data for garbage collection in preparation for new data being read in.

Exceptions:
ModelException if there are problems.

Implements datavisualizer.DataRequest.

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

Accepts a piece of tree float data from the parser.

If this particular piece is not wanted, do nothing.

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.

Reimplemented from datavisualizer.DataRequest.

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

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

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.

Reimplemented from datavisualizer.DataRequest.

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

Creates the tree map window.

Parameters:
oLegend Legend Legend for this detailed output file.
sChartTitle String Title of chart.
Exceptions:
ModelException if there is a problem drawing the window.
Returns:
JInternalFrame Frame with tree map.

Implements datavisualizer.DataRequest.

void datavisualizer.TreeMapCrownRadDataRequest.UpdateChart ( Legend  oLegend  )  throws ModelException [virtual]

Updates the tree map.

Parameters:
oLegend Legend Legend for this detailed output file.
Exceptions:
ModelException if there is a problem drawing the window.

Implements datavisualizer.DataRequest.

DefaultXYZDataset datavisualizer.TreeMapCrownRadDataRequest.UpdateForVisible ( Legend  oLegend,
DefaultXYZDataset  oDatasetToAdjust 
) throws ModelException [protected]

Returns a copy of the dataset with only those species which are marked as visible in the legend.

Parameters:
oLegend The legend for this chart.
oDatasetToAdjust The dataset to adjust for visible species.
Returns:
The copied dataset.
Exceptions:
ModelException Passing through underlying exceptions.

void datavisualizer.TreeMapCrownRadDataRequest.RestoreOriginalView (  )  [protected]

Restores the original view of the tree map with the scale at which it was first displayed.

void datavisualizer.TreeMapCrownRadDataRequest.Scroll ( int  iDirection  )  [protected]

Scrolls the view 10% in the specified direction.

If the view is full-size nothing happens. If the view is already scrolled all the way over in the specified direction nothing happens.

Parameters:
iDirection int Direction in which to scroll.

void datavisualizer.TreeMapCrownRadDataRequest.actionPerformed ( java.awt.event.ActionEvent  oEvent  ) 

Performs actions for the controls in the Histogram window.

Parameters:
oEvent Event triggered.

Reimplemented from datavisualizer.DataRequest.

void datavisualizer.TreeMapCrownRadDataRequest.SaveChartDataToFile ( boolean  bJustCurrTS  ) 

Writes a chart's data to a file.

This can write data for only the current timestep or the whole run.

Parameters:
bJustCurrTS If true, writes for only the current timestep. If false, writes for the whole run.

Reimplemented from datavisualizer.DataRequest.


Member Data Documentation

A vector of XYZDataItems, one for each species.

JTextField datavisualizer.TreeMapCrownRadDataRequest.m_jMinCrownRad = new JTextField("") [private]

Field displaying the minimum crown radius.

There will be one of these for each species

Holds the data codes for X.

Sized # species by # types.

Holds the data codes for Y.

Sized # species by # types.

Holds the data codes for crown radius .

Sized # species by # types.

Tree X coordinate.

Tree Y coordinate.

Tree crown radius value.

Minimum crown radius to draw.

Total number of species.

Total number of tree types.

Chart being displayed.

final int datavisualizer.TreeMapCrownRadDataRequest.LEFT = 1 [static, private]

Scrolling left.

final int datavisualizer.TreeMapCrownRadDataRequest.RIGHT = 2 [static, private]

Scrolling right.

final int datavisualizer.TreeMapCrownRadDataRequest.UP = 3 [static, private]

Scrolling up.

final int datavisualizer.TreeMapCrownRadDataRequest.DOWN = 4 [static, private]

Scrolling down.


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

Generated on Tue Apr 19 13:59:35 2011 for SORTIE Java Interface by  doxygen 1.5.6