javawrapper::HarvestInterfaceSetup Class Reference

This is a window allowing setup of the Harvest Interface behavior. More...

List of all members.

Public Member Functions

 HarvestInterfaceSetup (JFrame oParent, GUIManager oManager) throws ModelException
 Constructor.
void actionPerformed (java.awt.event.ActionEvent e)
 Controls actions for this window.

Protected Member Functions

void LoadData () throws ModelException
 Extracts data from the harvest interface behavior, making it ready for display
Exceptions:
ModelException Passing through from other called functions.

void RemoveColumn () throws ModelException
 Removes file columns from the list to add.
void ColumnUp () throws ModelException
 Moves a selected column up one position in the list.
void ColumnDown () throws ModelException
 Moves a selected column down one position in the list.
void AddDataMember () throws ModelException
 Adds a new data member, to be owned by this behavior.
void RemoveDataMember () throws ModelException
 Removes a new data member.
boolean OK () throws ModelException
 What happens when the OK button is clicked.

Protected Attributes

MainWindow m_oWindow
 Main window.
GUIManager m_oManager
 GUIManager object.
Behavior m_oBehaviorCopy
 Copy of the behavior, so we can cancel edits if the user desires.
JTextField m_jExecutablePathEdit = new JTextField()
 Field for capturing the executable's path and filename.
JTextField m_jSORTIEOutFileEdit = new JTextField()
 Field for capturing the filename that SORTIE is to write.
JTextField m_jExecutableHarvestOutFileEdit = new JTextField()
 Field for capturing the executable's harvest reply file.
JTextField m_jExecutableUpdateOutFileEdit = new JTextField()
 Field for capturing the executable's update reply file.
JTextField m_jBatchParamsFileEdit = new JTextField()
 Field for capturing the batch parameters file.
JTextField m_jBatchSingleRunParamsFileEdit = new JTextField()
 Field for capturing the file for a single run of batch parameters.
JTextField m_jNewTreeDataMemberEdit = new JTextField()
 Field for entering new tree data members.
JTextField m_jExecutableArgs = new JTextField()
 Field for capturing argument strings to pass to the executable.
JTextField m_jHarvestPeriod = new JTextField()
 Field for capturing the harvest period.
JList m_jAssignedCombosList
 The list displaying the assigned species/type combos for this behavior.
JList m_jNewTreeDataMembersList
 The list displaying the new tree data members for this behavior.
JList m_jFileColumnsList
 The list displaying the file columns.
JList m_jSpecies
 The list of species.
JList m_jTypes
 The list of types.
DefaultListModel m_jAssignedCombosListModel
 The assigned species/type combos for this behavior.
DefaultListModel m_jNewTreeDataMembersListModel
 The new tree data members for this behavior.
DefaultListModel m_jFileColumnsListModel
 The file columns for the harvest files.
Vector mp_sAllExistingDataMembers = new Vector(0)
 List of existing data members, so we can make sure any added have unique names.

Private Member Functions

void CreateGUI ()
 Creates the window.
void Browse (JTextField jText)
 Takes care of browsing.

Private Attributes

String m_sHelpID = "windows.edit_harvest_interface_window"
 The ID of the help file for this window.

Classes

class  FileColumnsChooser
 Dialog for choosing new file columns. More...


Detailed Description

This is a window allowing setup of the Harvest Interface behavior.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0
Edit history:
-------------------
September 29, 2006: Created (LEM)


Constructor & Destructor Documentation

javawrapper::HarvestInterfaceSetup::HarvestInterfaceSetup ( JFrame  oParent,
GUIManager  oManager 
) throws ModelException [inline]

Constructor.

Parameters:
oParent JFrame Parent frame
oManager GUIManager GUIManager object
Exceptions:
ModelException Passing through from called functions.


Member Function Documentation

void javawrapper::HarvestInterfaceSetup::actionPerformed ( java.awt.event.ActionEvent  e  )  [inline]

Controls actions for this window.

Parameters:
e ActionEvent.

void javawrapper::HarvestInterfaceSetup::AddDataMember (  )  throws ModelException [inline, protected]

Adds a new data member, to be owned by this behavior.

Exceptions:
ModelException if:
  • The data member is longer than 9 characters
  • It has the same name as an existing data member
  • It has parentheses in the name

void javawrapper::HarvestInterfaceSetup::Browse ( JTextField  jText  )  [inline, private]

Takes care of browsing.

Parameters:
jText JTextField The file field to browse for

void javawrapper::HarvestInterfaceSetup::ColumnDown (  )  throws ModelException [inline, protected]

Moves a selected column down one position in the list.

Exceptions:
ModelException if the request is to move a default column.

void javawrapper::HarvestInterfaceSetup::ColumnUp (  )  throws ModelException [inline, protected]

Moves a selected column up one position in the list.

Exceptions:
ModelException if the user has tried to disturb the default columns.

boolean javawrapper::HarvestInterfaceSetup::OK (  )  throws ModelException [inline, protected]

What happens when the OK button is clicked.

The data is validated and passed to the DisturbanceBehaviors object as needed.

Returns:
true if everything is correct; false if the process has been interrupted and the window should not close.
Exceptions:
ModelException if:
  • There are no species/type combos assigned
  • The path is missing to the executable, the harvest out file, or the harvest in file
  • The executable can't be found
  • A warning is issued if there is an update file listed but no new tree data members
  • The harvest period is not specified, is not a number, or is negative
  • Either the batch parameters file or the single run batch parameters file is present without the other
  • The batch parameters file is specified but does not exist

void javawrapper::HarvestInterfaceSetup::RemoveColumn (  )  throws ModelException [inline, protected]

Removes file columns from the list to add.

Exceptions:
ModelException if a column is not selected, or if the user tries to remove a default column from the list.

void javawrapper::HarvestInterfaceSetup::RemoveDataMember (  )  throws ModelException [inline, protected]

Removes a new data member.

Exceptions:
ModelException if there is not a data member selected.


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