sortie.gui.BatchSetup Class Reference

Window for working with batch files. More...

Inheritance diagram for sortie.gui.BatchSetup:

Public Member Functions
	BatchSetup (JFrame jParent, GUIManager oManager)
	Constructor. More...
	BatchSetup (JFrame jParent, GUIManager oManager, String sBatchFile) throws ModelException
	Constructor. More...
void	actionPerformed (ActionEvent oEvent)
	Controls actions for this window. More...
void	addParFile (String sParFileName, int iNumTimesToRun)
	Adds a new parameter file to the list for this batch. More...

Private Member Functions
void	addFile ()
	Adds a parameter file and number of times to the batch list. More...
void	writeFile () throws ModelException
	Writes the batch file. More...

Private Attributes
GUIManager	m_oManager
	GUI Manager. More...
DefaultListModel< BatchParFile >	m_jParFilesListModel = new DefaultListModel<BatchParFile>()
	List model of parameter files currently added to file. More...
JList< BatchParFile >	m_jParFilesList = new JList<BatchParFile>(m_jParFilesListModel)
	List of parameter files currently added to file. More...
JTextField	m_jParFileEdit = new JTextField()
	Text field holding a proposed parameter file path and name. More...
JTextField	m_jBatchFileEdit = new JTextField()
	Text field holding the batch file path and name. More...
JTextField	m_jNumTimesToRun = new JTextField()
	Holds number of times to run a parameter file. More...
String	m_sHelpID = "windows.batch_setup_window"
	Help topic ID. More...

Detailed Description

Window for working with batch files.

Copyright: Copyright (c) Charles D. Canham 2005

Company: Cary Institute of Ecosystem Studies

Author

Lora E. Murphy

Version

1.0
Edit history:
---------------—
March 31, 2005: Created (LEM)
May 26, 2006: Improved - changed some things that annoyed me (LEM)
April 5, 2007: Support for multi-file select (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

BatchSetup() [1/2]

sortie.gui.BatchSetup.BatchSetup	(	JFrame	jParent,
		GUIManager	oManager
	)

Constructor.

Creates the window and displays it.

Parameters

jParent	JFrame Parent frame for this dialog.
oManager	GUIManager object.

BatchSetup() [2/2]

sortie.gui.BatchSetup.BatchSetup	(	JFrame	jParent,
		GUIManager	oManager,
		String	sBatchFile
	)		throws ModelException

Constructor.

This reads an existing batch file in so it can be edited.

Parameters

jParent	JFrame Parent frame for this dialog.
oManager	GUIManager object.
sBatchFile	String Batch filename.

Exceptions

ModelException

Wrapping parse exceptions.

Member Function Documentation

actionPerformed()

void sortie.gui.BatchSetup.actionPerformed

(

ActionEvent

oEvent

)

Controls actions for this window.

Parameters

oEvent

ActionEvent.

addFile()

void sortie.gui.BatchSetup.addFile ( )

private

Adds a parameter file and number of times to the batch list.

This alerts the user if anything's missing or the data cannot be understood.

addParFile()

void sortie.gui.BatchSetup.addParFile	(	String	sParFileName,
		int	iNumTimesToRun
	)

Adds a new parameter file to the list for this batch.

Parameters

sParFileName	String Filename of new parameter file.
iNumTimesToRun	int Number of times to run the file.

writeFile()

void sortie.gui.BatchSetup.writeFile ( ) throws ModelException

private

Writes the batch file.

Exceptions

ModelException

wrapping an IOException.

Member Data Documentation

m_jBatchFileEdit

JTextField sortie.gui.BatchSetup.m_jBatchFileEdit = new JTextField()

private

Text field holding the batch file path and name.

m_jNumTimesToRun

JTextField sortie.gui.BatchSetup.m_jNumTimesToRun = new JTextField()

private

Holds number of times to run a parameter file.

m_jParFileEdit

JTextField sortie.gui.BatchSetup.m_jParFileEdit = new JTextField()

private

Text field holding a proposed parameter file path and name.

m_jParFilesList

JList<BatchParFile> sortie.gui.BatchSetup.m_jParFilesList = new JList<BatchParFile>(m_jParFilesListModel)

private

List of parameter files currently added to file.

m_jParFilesListModel

DefaultListModel<BatchParFile> sortie.gui.BatchSetup.m_jParFilesListModel = new DefaultListModel<BatchParFile>()

private

List model of parameter files currently added to file.

m_oManager

GUIManager sortie.gui.BatchSetup.m_oManager

private

GUI Manager.

m_sHelpID

String sortie.gui.BatchSetup.m_sHelpID = "windows.batch_setup_window"

private

Help topic ID.

---

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

• BatchSetup.java