org.trianacode.gui.extensions

Class FileImportExportDecorator

java.lang.Object

org.trianacode.gui.extensions.FileImportExportDecorator

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

public class FileImportExportDecorator
extends java.lang.Object
implements java.awt.event.ActionListener

Decorator design pattern implementation that adds import and export specific plugin functionality to file dialogs in Triana. The import and export filters are dynamically configured.

Constructor Summary

Constructors

Constructor and Description
FileImportExportDecorator(javax.swing.JFileChooser filechooser)

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Invoked when an action occurs.
void	exportWorkflow(TaskGraph taskgraph) Converts the taskgraph to the appropriate format and writes it to the user choosen file.
java.lang.String	getDefaultToolPackage()
Tool[]	importTools(java.lang.String pack) Translates and returns the an array of Tool objects from the file choosen by the user.
TaskGraph	importWorkflow() Translates and returns the TaskGraph from the file choosen by the user.
int	showExportDialog(java.awt.Component parent) Pops up a "Export Taskgraph" file chooser dialog.
int	showImportDialog(java.awt.Component parent) Pops up a "Import Taskgraph" file chooser dialog.
int	showImportToolDialog(java.awt.Component parent) Pops up a "Import Tool" file chooser dialog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileImportExportDecorator

public FileImportExportDecorator(javax.swing.JFileChooser filechooser)

Method Detail

showImportDialog

public int showImportDialog(java.awt.Component parent)

Pops up a "Import Taskgraph" file chooser dialog.

Parameters:

parent - the parent component of the dialog, can be null; see showDialog for details

Returns:

the return state of the file chooser on popdown:

• JFileChooser.CANCEL_OPTION
• JFileChooser.APPROVE_OPTION
• JFileCHooser.ERROR_OPTION if an error occurs or the dialog is dismissed

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless()

showImportToolDialog

public int showImportToolDialog(java.awt.Component parent)

Pops up a "Import Tool" file chooser dialog.

Parameters:

parent - the parent component of the dialog, can be null; see showDialog for details

Returns:

the return state of the file chooser on popdown:

• JFileChooser.CANCEL_OPTION
• JFileChooser.APPROVE_OPTION
• JFileCHooser.ERROR_OPTION if an error occurs or the dialog is dismissed

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless()

showExportDialog

public int showExportDialog(java.awt.Component parent)

Pops up a "Export Taskgraph" file chooser dialog.

Parameters:

parent - the parent component of the dialog, can be null; see showDialog for details

Returns:

the return state of the file chooser on popdown:

• JFileChooser.CANCEL_OPTION
• JFileChooser.APPROVE_OPTION
• JFileCHooser.ERROR_OPTION if an error occurs or the dialog is dismissed

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Invoked when an action occurs.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

importWorkflow

public TaskGraph importWorkflow()
                         throws TaskGraphException,
                                java.io.IOException

Translates and returns the TaskGraph from the file choosen by the user.

Returns:

the imported taskgraph thrown if the taskgraph or workflow format is invalid or unparsable, non matching brackets for example.

Throws:

java.io.IOException - thrown if there is a file IO problem.

TaskGraphException

exportWorkflow

public void exportWorkflow(TaskGraph taskgraph)
                    throws java.io.IOException,
                           TaskGraphException

Converts the taskgraph to the appropriate format and writes it to the user choosen file.

Parameters:

taskgraph - the taskgraph to export

Throws:

java.io.IOException - thrown if there is an IO problem writing the file.

TaskGraphException

getDefaultToolPackage

public java.lang.String getDefaultToolPackage()

Returns:

the current default package for imported tools.

importTools

public Tool[] importTools(java.lang.String pack)
                   throws TaskGraphException,
                          java.io.IOException

Translates and returns the an array of Tool objects from the file choosen by the user.

Parameters:

pack - the suggested package for imported tools

pack -

Returns:

the imported tool thrown if the tool format is invalid or unparsable, non matching brackets for example.

Throws:

java.io.IOException - thrown if there is a file IO problem.

TaskGraphException