javawrapper.DataVisualizerManager Class Reference

This class takes care of managing data visualization. More...

List of all members.

Public Member Functions

 DataVisualizerManager (JDesktopPane jDesktop, JScrollPane jScroller)
 Constructor.
void DrawChart (String sFile, String sChartChoice) throws ModelException
 Draws a chart on the desktop.
void CloseFile (String sFileName)
 Closes a detailed output file.
void CleanUp ()
 Causes all objects under management to perform any cleanup operations.
void AddFile (String sFileName) throws ModelException
 Notifies this object of a new output file.
void AddCurrentRunFile (String sFileName) throws ModelException
 Notifies this object of a new output file for the current run.
boolean AreCurrentRunChartsOpen ()
 Tells whether there are any charts open for the current run (for real- time data visualization).
void UpdateCurrentRunCharts () throws ModelException
 Updates any charts open for the current run.
void CloseCurrentRunCharts (MainWindow oWindow)
 Closes all charts associated with the current run.
String[] GetChartOptionsForFile (String sFileName) throws ModelException
 Gets the list of chart options for an output file, ready to display in a combo box.

Package Attributes

JDesktopPane m_jDesktop
 Here's where this class will put windows.
DesktopListener m_oDesktopListener
 Listener to be assigned to all internal frames added by this class.
Vector< DataFileManagermp_oDataManagers = new Vector<DataFileManager>(0)
 Data file managers - one for each open data file.
Vector< DataFileManagermp_oCurrentRunDataManagers = new Vector<DataFileManager>(0)
 Data file managers - one for each output file of the current run - this is a subset of mp_oDataManagers.

Private Member Functions

DataFileManager MakeDataManager (String sFileName) throws ModelException
 Creates a new data manager.

Private Attributes

int m_iNumOpenPositions = 0
 The number of positions available in which to put a newly opened window.


Detailed Description

This class takes care of managing data visualization.

It keeps track of open files and causes their data windows to be placed on the main application window.

A current run may be opened for visualization as well. These files will be kept track of separately and updated on command.

When a new window is opened, if it is the first window open, it is placed at the upper right of the screen, just to the right of its legend, which is in the upper right corner. When the next window is opened, if a window is already in that position, it opens itself 20 pixels down and to the left. Subsequent windows open themselves 20 pixels down and to the left until the middle of the screen is reached, at which point the cycle returns to the upper right. If a window is opened and then moved, the next window open will grab its former spot.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
July 30, 2004: Allowed for output files to be closed (LEM)
November 18, 2004: Added real-time data visualization
October 13, 2005: Added desktop scroll bar support (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

javawrapper.DataVisualizerManager.DataVisualizerManager ( JDesktopPane  jDesktop,
JScrollPane  jScroller 
)

Constructor.

Parameters:
jDesktop Desktop pane.
jScroller Scroll pane enclosing jDesktop.


Member Function Documentation

void javawrapper.DataVisualizerManager.DrawChart ( String  sFile,
String  sChartChoice 
) throws ModelException

Draws a chart on the desktop.

Parameters:
sFile The filename from which to draw the chart.
sChartChoice The chart to draw on the desktop.
Exceptions:
ModelException If the filename is not valid, or the chart choice cannot be drawn, or wrapping another error.

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

void javawrapper.DataVisualizerManager.CloseFile ( String  sFileName  ) 

Closes a detailed output file.

If the file doesn't match any files under management, nothing happens.

Parameters:
sFileName File to close.

void javawrapper.DataVisualizerManager.CleanUp (  ) 

Causes all objects under management to perform any cleanup operations.

Each should have its own CleanUp function; this will be called for each.


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

void javawrapper.DataVisualizerManager.AddFile ( String  sFileName  )  throws ModelException

Notifies this object of a new output file.

This should be a file not being generated by the current run.

Parameters:
sFileName The filename.
Exceptions:
ModelException if this is not a recognized output file.

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

void javawrapper.DataVisualizerManager.AddCurrentRunFile ( String  sFileName  )  throws ModelException

Notifies this object of a new output file for the current run.

This file is subject to continuous updating.

Parameters:
sFileName The filename.
Exceptions:
ModelException if this is not a recognized output file.

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

DataFileManager javawrapper.DataVisualizerManager.MakeDataManager ( String  sFileName  )  throws ModelException [private]

Creates a new data manager.

This checks for the prior existence of a manager for the given file; if it already exists, the user is warned and nothing is done.

Parameters:
sFileName String The file name for which to create a new file manager
Returns:
DataFileManager The newly created manager, or null if the file already has a manager.
Exceptions:
ModelException if the file type is not recognized, or if there is a problem creating the manager.

boolean javawrapper.DataVisualizerManager.AreCurrentRunChartsOpen (  ) 

Tells whether there are any charts open for the current run (for real- time data visualization).

Returns:
boolean True if there are any charts open for real-time data visualization. Returns false if there are no current run files loaded, or if they have no charts open.

void javawrapper.DataVisualizerManager.UpdateCurrentRunCharts (  )  throws ModelException

Updates any charts open for the current run.

If there are no open charts for the current run, this does nothing. This allows the file managers to decide how best to handle this, but the expectation is that they will display the most recent available data.

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

void javawrapper.DataVisualizerManager.CloseCurrentRunCharts ( MainWindow  oWindow  ) 

Closes all charts associated with the current run.

Parameters:
oWindow Window so we can tell it to get rid of the file names from its options window

String [] javawrapper.DataVisualizerManager.GetChartOptionsForFile ( String  sFileName  )  throws ModelException

Gets the list of chart options for an output file, ready to display in a combo box.

Parameters:
sFileName The filename.
Returns:
The file choices to display for this file.
Exceptions:
ModelException if the file cannot be found.

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


Member Data Documentation

Here's where this class will put windows.

Listener to be assigned to all internal frames added by this class.

Data file managers - one for each open data file.

Data file managers - one for each output file of the current run - this is a subset of mp_oDataManagers.

The number of positions available in which to put a newly opened window.


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

Generated on Wed Oct 28 14:01:19 2009 for SORTIE Java Interface by  doxygen 1.5.6