datavisualizer::GridHistogramDataRequest Class Reference

This controls the drawing of a histogram for a single piece of grid information. More...

Inheritance diagram for datavisualizer::GridHistogramDataRequest:

datavisualizer::DataRequest List of all members.

Public Member Functions

 GridHistogramDataRequest (String sLabel, boolean bIsFloat, DetailedOutputFileManager oManager, String sGraphName, String sGridName)
 Constructor.
void actionPerformed (ActionEvent oEvent)
 Performs actions for the controls in the Histogram window.
float GetBinSize ()
 Gets the bin size for this data request's histogram.
boolean GetUseLogarithmicAxis ()
 Gets whether or not to use a logarithmic axis.
void AddGridFloatDataMemberCode (String sGridName, String sLabel, int iCode)
 Captures the data member code if we're graphing a float.
void AddGridIntDataMemberCode (String sGridName, String sLabel, int iCode)
 Captures the data member code if we're graphing an integer.
boolean WantAnyGridInts ()
 If our data piece that's being graphed is an integer, this returns true.
boolean WantAnyGridFloats ()
 If our data piece that's being graphed is a float, this returns true.
void AddGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal)
 Accepts the value of our data member from the parser, if float.
void AddGridIntData (String sGridName, int iX, int iY, int iCode, int iVal)
 This will add the integer data, if the data for this chart is an int that matches the data member code.

Protected Member Functions

void WriteChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException
 Writes the histogram's data to tab-delimited text.
float GetDatasetMean ()
 Calculates the mean value of all values currently in mp_oData.
void AddSeriesToDataset ()
 This will add all series to the dataset.

Protected Attributes

ModelHistogramDataset m_oDataset
 The dataset that will be graphed.

Package Functions

ModelInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws ModelException
 Creates the histogram using data accumulated thus far.
void UpdateChart (Legend oLegend) throws ModelException
 Updates the histogram.
void ClearData ()
 This nulls our dataset and recreates it, and clears all of our data vectors.

Package Attributes

java.text.DecimalFormat m_jSmallNumsFormat
 Formatter for very small numbers.

Private Attributes

String m_sLabel
 Data member's label, as it appears in the detailed output file.
String m_sGridName
 Name of grid.
boolean m_bIsFloat
 Whether our data member being graphed is a float.
boolean m_bIsInt
 Whether the data being graphed is an integer.
JTextField m_jNumBins = new JTextField("")
 Field displaying the number of bins in the histogram.
JTextField m_jBinSize = new JTextField("")
 Field displaying the bin size in the histogram.
JLabel m_jMean = new JLabel("")
 Label holding mean value of dataset.
int m_iDataMemberCode = -1
 The data member code for this data member.
Vector mp_oData = new Vector(0)
 The data.
float m_fBinSize
 Size of the histogram bins.
int m_iNumBins
 Number of bins in the histogram.
boolean m_bUseLogarithmicAxis
 Whether or not to use a logarithmic axis on the Y.
boolean m_bRecalcBinsOnUpdate
 Whether or not we have to recalculate the bins on chart update (i.e.
java.text.NumberFormat m_jFormat = java.text.NumberFormat.getInstance()
 Formatter for big numbers.

Detailed Description

This controls the drawing of a histogram for a single piece of grid information.

The label of the data is passed in the constructor. The histogram is defaulted to 10 divisions equally divided between their minimum and maximum values.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
March 29, 2005: Created (LEM)


Constructor & Destructor Documentation

datavisualizer::GridHistogramDataRequest::GridHistogramDataRequest ( String  sLabel,
boolean  bIsFloat,
DetailedOutputFileManager  oManager,
String  sGraphName,
String  sGridName 
) [inline]

Constructor.

Parameters:
sLabel Label of the piece of data, as it would be passed as a data member code.
bIsFloat Whether this is float data. If this is set to false, integer data is assumed.
oManager The parent detailed output file manager.
sGraphName Name of graph string.
sGridName Name of grid.

Edit history:
------------------
March 29, 2005: Created (LEM)


Member Function Documentation

void datavisualizer::GridHistogramDataRequest::actionPerformed ( ActionEvent  oEvent  )  [inline]

Performs actions for the controls in the Histogram window.

Parameters:
oEvent Event triggered.

void datavisualizer::GridHistogramDataRequest::AddGridFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal 
) [inline]

Accepts the value of our data member from the parser, if float.

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:
------------------
April 28, 2004: Submitted in beta version (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::GridHistogramDataRequest::AddGridFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

Captures the data member code if we're graphing a float.

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

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

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::GridHistogramDataRequest::AddGridIntData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal 
) [inline]

This will add the integer data, if the data for this chart is an int that matches the data member code.

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.
iVal Value.

Edit history:
------------------ March 29, 2005: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::GridHistogramDataRequest::AddGridIntDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

Captures the data member code if we're graphing an integer.

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

Edit history:
------------------ March 29, 2005: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::GridHistogramDataRequest::AddSeriesToDataset (  )  [inline, protected]

This will add all series to the dataset.


Edit history:
------------------ March 29, 2005: Created (LEM)

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

This nulls our dataset and recreates it, and clears all of our data vectors.


Edit history:
------------------ March 29, 2005: Created (LEM)

Implements datavisualizer::DataRequest.

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

Creates the histogram using data accumulated thus far.

Parameters:
oLegend Legend for this chart.
sChartTitle Title for this chart.
Returns:
The new chart window.
Exceptions:
datavisualizer.ModelException Passing through underlying exceptions.

Edit history:
------------------ March 29, 2005: Created (LEM)

Implements datavisualizer::DataRequest.

float datavisualizer::GridHistogramDataRequest::GetBinSize (  )  [inline]

Gets the bin size for this data request's histogram.

Returns:
The bin size.

Edit history:
------------------ March 29, 2005: Created (LEM)

float datavisualizer::GridHistogramDataRequest::GetDatasetMean (  )  [inline, protected]

Calculates the mean value of all values currently in mp_oData.

Returns:
float Mean of all values.

boolean datavisualizer::GridHistogramDataRequest::GetUseLogarithmicAxis (  )  [inline]

Gets whether or not to use a logarithmic axis.

Returns:
True if a logarithmic axis should be used, or false if a linear axis should be used.

Edit history:
------------------ March 29, 2005: Created (LEM)

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

Updates the histogram.

Parameters:
oLegend Legend for this chart.
Exceptions:
datavisualizer.ModelException Passing through an underlying exception.

Edit history:
------------------ March 29, 2005: Created (LEM)

Implements datavisualizer::DataRequest.

boolean datavisualizer::GridHistogramDataRequest::WantAnyGridFloats (  )  [inline]

If our data piece that's being graphed is a float, this returns true.

Otherwise, false.

Returns:
Whether this object's data piece is a float.

Edit history:
------------------ March 29, 2005: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

boolean datavisualizer::GridHistogramDataRequest::WantAnyGridInts (  )  [inline]

If our data piece that's being graphed is an integer, this returns true.

Otherwise, false.

Returns:
Whether this object's data piece is an integer.

Edit history:
------------------ March 29, 2005: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

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

Writes the histogram'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.


Member Data Documentation

boolean datavisualizer::GridHistogramDataRequest::m_bRecalcBinsOnUpdate [private]

Whether or not we have to recalculate the bins on chart update (i.e.

we are charting an unknown data type without defaults)

java.text.DecimalFormat datavisualizer::GridHistogramDataRequest::m_jSmallNumsFormat [package]

Initial value:

 new java.text.DecimalFormat(
        "0.#E0")
Formatter for very small numbers.


The documentation for this class was generated from the following file:
Generated on Wed Nov 29 08:45:01 2006 for SORTIE Java Interface by  doxygen 1.4.7