repicea.io.tools

Class REpiceaExportTool

java.lang.Object

repicea.io.tools.REpiceaExportTool

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.CaretListener, javax.swing.event.ListSelectionListener, REpiceaShowableUIWithParent, REpiceaUIObjectWithParent

Direct Known Subclasses:

CATExportTool

public abstract class REpiceaExportTool
extends java.lang.Object
implements REpiceaShowableUIWithParent, javax.swing.event.CaretListener, javax.swing.event.ListSelectionListener

The REpiceaExportTool class is an abstract class that can save a file from particular record sets. The UI interface of this class also provides an export option list and a file selection panel. The export options are defined in the abstract method defineExportOptions() while the record sets are built through the createRecordSets(List selectedExportOptions) method. By default, the format is dbf, the user can select other format though.

Each record set is given a worker that computes the record and passes them to an associated thread that write them down in a file. The first worker has a queue from which the saving thread picks the records. Consequently, the exportRecordSets method returns a series of empty REpiceaRecordSet instances. If the saving is disabled through the setSaveFileEnabled method, then the exportRecordSets method returns a series of complete REpiceaRecordSet instances.

To use this class, first define a derived class that implements the two abstract methods. To export a dbf file, first instantiate an object of the derived class. Then use the three following method:

setFilename(myFile);
setSelectedOptions(mySelectedOptions);
exportRecordSets();

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	REpiceaExportTool.FieldName The FieldName enum class defines the field names during the export.
static class	REpiceaExportTool.InternalSwingWorkerForRecordSet The abstract InternalSwingWorkerForRecordSet class is derived from the AbstractGenericTask class.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	appendFileEnabled
protected REpiceaExportToolDialog	guiInterface
protected boolean	multipleSelection
protected boolean	saveFileEnabled
protected java.util.List<java.lang.Enum>	selectedExportOptions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	REpiceaExportTool() General constructor with multiple selection mode set to false.
protected	REpiceaExportTool(boolean multipleSelection) General constructor.

Method Summary

Modifier and Type	Method and Description
void	caretUpdate(javax.swing.event.CaretEvent evt)
protected java.util.Map<java.lang.Enum,REpiceaRecordSet>	createRecordSets(java.util.List<java.lang.Enum> selectedOptions) This method instantiates a InternalSwingWorkerForRecordSet-derived class, which handles the construction of the GRecordSet instance.
protected abstract java.util.List<java.lang.Enum>	defineAvailableExportOptions() This method sets the available export options.
java.util.Map<java.lang.Enum,REpiceaRecordSet>	exportRecordSets() This method creates the different record sets depending on the selected export options.
protected java.util.List<java.lang.Enum>	getAvailableExportOptions()
protected java.lang.String	getFilename()
protected java.util.List<java.lang.Enum>	getSelectedExportOptions()
REpiceaExportToolDialog	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
protected abstract REpiceaExportTool.InternalSwingWorkerForRecordSet	instantiateInternalSwingWorkerForRecordSet(java.lang.Enum selectedOption, REpiceaRecordSet recordSet) This abstract method instantiates an InternalSwingWorkerForRecordSet-derived class, which is supposed to handle the construction of the GRecordSet instance.
protected boolean	isAppendFileEnabled()
boolean	isCanceled() Returns true if the cancel button of the dialog has been pressed.
boolean	isVisible() This method returns true if the GUI is visible.
protected void	removeExportOption(java.lang.Enum exportOption) This method makes it possible to remove one export option if desired.
void	setAppendFileEnabled(boolean appendFileEnabled) If set to true, the export tool does not delete the file but rather it appends the records to the existing file.
protected void	setCanceled(boolean isCanceled)
void	setFilename(java.lang.String filename) This method sets the filename of the output file.
void	setMultipleSelection(boolean bool) This method makes it possible to enable or disable the multiple export.
protected void	setSaveFileEnabled(boolean bool) This method makes it possible to disable the saving to file.
void	setSelectedOptions(java.util.List<java.lang.Enum> selectedOptions) This method sets the export options.
void	showUI(java.awt.Window parent) This method shows the GUI interface of the class that implements this interface.
void	valueChanged(javax.swing.event.ListSelectionEvent arg0)

Methods inherited from class java.lang.Object

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

Field Detail

selectedExportOptions

protected java.util.List<java.lang.Enum> selectedExportOptions

guiInterface

protected transient REpiceaExportToolDialog guiInterface

multipleSelection

protected boolean multipleSelection

saveFileEnabled

protected boolean saveFileEnabled

appendFileEnabled

protected boolean appendFileEnabled

Constructor Detail

REpiceaExportTool

protected REpiceaExportTool(boolean multipleSelection)

General constructor.

Parameters:

multipleSelection - true to enable the multiple selection list in the user interface.

REpiceaExportTool

protected REpiceaExportTool()

General constructor with multiple selection mode set to false.

Method Detail

setMultipleSelection

public void setMultipleSelection(boolean bool)

This method makes it possible to enable or disable the multiple export.

Parameters:

bool - a boolean

defineAvailableExportOptions

protected abstract java.util.List<java.lang.Enum> defineAvailableExportOptions()

This method sets the available export options. It is to be defined in the derived classes.

Returns:

a vector that contains the different export options

createRecordSets

protected final java.util.Map<java.lang.Enum,REpiceaRecordSet> createRecordSets(java.util.List<java.lang.Enum> selectedOptions)
                                                                         throws java.lang.Exception

This method instantiates a InternalSwingWorkerForRecordSet-derived class, which handles the construction of the GRecordSet instance. If the worker does not terminate correctly, an exception is thrown.

Parameters:

selectedOption - the selected option

Returns:

a GRecordSet instance

Throws:

java.lang.Exception - if the worker does not terminate correctly

instantiateInternalSwingWorkerForRecordSet

protected abstract REpiceaExportTool.InternalSwingWorkerForRecordSet instantiateInternalSwingWorkerForRecordSet(java.lang.Enum selectedOption,
                                                                                                                REpiceaRecordSet recordSet)

This abstract method instantiates an InternalSwingWorkerForRecordSet-derived class, which is supposed to handle the construction of the GRecordSet instance.

Parameters:

recordSet - a REpiceaRecordSet instance

selectedOption - the selected output format

Returns:

the InternalSwingWorkerForRecordSet-derived instance

getSelectedExportOptions

protected java.util.List<java.lang.Enum> getSelectedExportOptions()

setSelectedOptions

public void setSelectedOptions(java.util.List<java.lang.Enum> selectedOptions)
                        throws java.lang.Exception

This method sets the export options. If the selectedOption Enum variable is not part of the available export options, an exception is thrown. If multiple selections are not allowed, a list of two or more Enum will throw an exception. The multiple selection mode can be enabled through the setMultipleSelection method.

Parameters:

selectedOptions - a set of Enum variables that should be among the available export options

Throws:

java.lang.Exception

removeExportOption

protected void removeExportOption(java.lang.Enum exportOption)

This method makes it possible to remove one export option if desired. The method is protected against the removal of all options: the last one will always remain. If the specified export option is not found in the available export option nothing happens.

Parameters:

exportOption - an enum variable that corresponds to the export option to be removed

getAvailableExportOptions

protected java.util.List<java.lang.Enum> getAvailableExportOptions()

isAppendFileEnabled

protected boolean isAppendFileEnabled()

setAppendFileEnabled

public void setAppendFileEnabled(boolean appendFileEnabled)

If set to true, the export tool does not delete the file but rather it appends the records to the existing file.

Parameters:

appendFileEnabled -

setCanceled

protected void setCanceled(boolean isCanceled)

isCanceled

public boolean isCanceled()

Returns true if the cancel button of the dialog has been pressed.

Returns:

a boolean

setFilename

public void setFilename(java.lang.String filename)

This method sets the filename of the output file.

Parameters:

filename - a String

Throws:

java.io.IOException - if the file type is unknown

getFilename

protected java.lang.String getFilename()

getUI

public REpiceaExportToolDialog getUI(java.awt.Container parent)

Description copied from interface: REpiceaUIObjectWithParent

This method returns the GUI interface of the class that implements this interface.

Specified by:

getUI in interface REpiceaUIObjectWithParent

Parameters:

parent - a parent Container instance (can be null)

Returns:

a Component instance

showUI

public void showUI(java.awt.Window parent)

Description copied from interface: REpiceaShowableUIWithParent

This method shows the GUI interface of the class that implements this interface.

Specified by:

showUI in interface REpiceaShowableUIWithParent

Parameters:

parent - the parent Window instance (can be null)

caretUpdate

public void caretUpdate(javax.swing.event.CaretEvent evt)

Specified by:

caretUpdate in interface javax.swing.event.CaretListener

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent arg0)

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

exportRecordSets

public java.util.Map<java.lang.Enum,REpiceaRecordSet> exportRecordSets()
                                                                throws java.lang.Exception

This method creates the different record sets depending on the selected export options. If the saving is enabled, and it is by default, then the method returns a series of empty REpiceaRecordSet instance. These are empty because the saving thread picks all the records to write them into a file. If the saving is disabled, then the REpiceaRecordSet instances are full.

Returns:

a Map with the selected options (keys) and their associated record sets (values)

Throws:

java.lang.Exception

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObjectWithParent

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObjectWithParent

Returns:

a boolean

setSaveFileEnabled

protected void setSaveFileEnabled(boolean bool)

This method makes it possible to disable the saving to file. Then the Map that results from exportRecordSets() won't be empty.

Parameters:

bool - a boolean