datavisualizer::DataFileManager Class Reference

This class manages a single data file for the data visualizer. More...

Inheritance diagram for datavisualizer::DataFileManager:

datavisualizer::DetailedOutputFileManager datavisualizer::ShortOutputFileManager List of all members.

Public Member Functions

Legend GetLegend ()
 Get the legend for this file.
int GetNumberOpenCharts ()
 Gets the number of open charts for this file.
void CloseAllCharts ()
 Closes all the open charts for this window.
void CleanUp ()
 Any clean-up tasks that must be done can be put here.
 DataFileManager (String sFileName)
 Constructor.
String GetFileName ()
 Gets the file being managed.
abstract String[] GetLineGraphOptions ()
 Gets a list of the line graphs this object is capable of drawing.
abstract String[] GetMapOptions ()
 Gets a list of maps this object is capable of drawing.
abstract String[] GetHistogramOptions ()
 Gets a list of histograms this object is capable of drawing.
abstract String[] GetTableOptions ()
 Gets a list of tables this object is capable of drawing.
JInternalFrame CreateNewChart (String sGraphName) throws ModelException
 Creates a requested chart as a JInternalFrame.
abstract void UpdateCharts () throws ModelException
 Prompts the redrawing of all open charts.
abstract void UpdateCurrentRunCharts () throws ModelException
 Prompts the redrawing of open charts for the current run.

Protected Member Functions

abstract JInternalFrame DrawChart (String sGraphName) throws ModelException
 Creates a requested chart as a JInternalFrame.

Protected Attributes

String m_sFilename
 File under management.
Vector mp_oCharts
 All charts under management.
Legend m_oLegend
 The legend for this file.

Detailed Description

This class manages a single data file for the data visualizer.

It is responsible for parsing the data out of the file, telling the data visualizer what charts are available, and providing requested charts.

Each DataFileManager object keeps track of the charts it has created and placed in JInternalFrame objects. These objects are under the direct management of the entitity to which they were originally passed when DrawChart() was called to create them, but the DataFileManager object retains the ability to update them per user request.

Copyright: Copyright (c) Charles D. Canham 2004

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
November 18, 2004: Added real-time data visualization (LEM)


Constructor & Destructor Documentation

datavisualizer::DataFileManager::DataFileManager ( String  sFileName  )  [inline]

Constructor.

Parameters:
sFileName File name for this manager to manage.

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


Member Function Documentation

Legend datavisualizer::DataFileManager::GetLegend (  )  [inline]

Get the legend for this file.

Returns:
The legend.

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

int datavisualizer::DataFileManager::GetNumberOpenCharts (  )  [inline]

Gets the number of open charts for this file.

Returns:
int Number of open charts for this file.

void datavisualizer::DataFileManager::CleanUp (  )  [inline]

Any clean-up tasks that must be done can be put here.

This will be called before the object is destroyed.


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

Reimplemented in datavisualizer::DetailedOutputFileManager.

String datavisualizer::DataFileManager::GetFileName (  )  [inline]

Gets the file being managed.

Returns:
File name of managed file.

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

abstract String [] datavisualizer::DataFileManager::GetLineGraphOptions (  )  [pure virtual]

Gets a list of the line graphs this object is capable of drawing.

Returns:
List of line graph labels

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

Implemented in datavisualizer::DetailedOutputFileManager, and datavisualizer::ShortOutputFileManager.

abstract String [] datavisualizer::DataFileManager::GetMapOptions (  )  [pure virtual]

Gets a list of maps this object is capable of drawing.

Returns:
List of map labels

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

Implemented in datavisualizer::DetailedOutputFileManager, and datavisualizer::ShortOutputFileManager.

abstract String [] datavisualizer::DataFileManager::GetHistogramOptions (  )  [pure virtual]

Gets a list of histograms this object is capable of drawing.

Returns:
List of histogram labels

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

Implemented in datavisualizer::DetailedOutputFileManager, and datavisualizer::ShortOutputFileManager.

abstract String [] datavisualizer::DataFileManager::GetTableOptions (  )  [pure virtual]

Gets a list of tables this object is capable of drawing.

Returns:
List of table labels

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

Implemented in datavisualizer::DetailedOutputFileManager, and datavisualizer::ShortOutputFileManager.

abstract JInternalFrame datavisualizer::DataFileManager::DrawChart ( String  sGraphName  )  throws ModelException [protected, pure virtual]

Creates a requested chart as a JInternalFrame.

The JInternalFrame will not be packed or set to visible - it will simply have its GUI components. If the chart requested already exists, the existing chart is returned.

Parameters:
sGraphName The string name of the chart - should be from one of the "GetXOptions()" methods
Returns:
The chart window, or null if no such chart can be drawn.
Exceptions:
ModelException if there are any problems drawing the chart.

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

Implemented in datavisualizer::DetailedOutputFileManager, and datavisualizer::ShortOutputFileManager.

JInternalFrame datavisualizer::DataFileManager::CreateNewChart ( String  sGraphName  )  throws ModelException [inline]

Creates a requested chart as a JInternalFrame.

If the chart already exists, a new one is not created; the existing one is returned. If the chart is new, the JInternalFrame will not be packed or set to visible - it will simply have its GUI components.

Parameters:
sGraphName The string name of the chart - should be from one of the "GetXOptions()" methods
Returns:
The chart window, or null if no such chart can be drawn.
Exceptions:
ModelException if there are any problems drawing the chart.

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

abstract void datavisualizer::DataFileManager::UpdateCharts (  )  throws ModelException [pure virtual]

Prompts the redrawing of all open charts.

Exceptions:
ModelException wrapping other exceptions

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

Implemented in datavisualizer::DetailedOutputFileManager, and datavisualizer::ShortOutputFileManager.

abstract void datavisualizer::DataFileManager::UpdateCurrentRunCharts (  )  throws ModelException [pure virtual]

Prompts the redrawing of open charts for the current run.

The data file manager should search for and display the most recent information.

Exceptions:
ModelException if there is a problem drawing the charts.

Implemented in datavisualizer::DetailedOutputFileManager, and datavisualizer::ShortOutputFileManager.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:51 2007 for SORTIE Java Interface by  doxygen 1.5.2