repicea.io.tools

Class ExportTool

java.lang.Object

repicea.io.tools.ExportTool

All Implemented Interfaces:

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

Deprecated.

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

The ExportTool 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 setRecordSet(Enum selectedExportOption) method. By default, the format is dbf, the user can select other format though.
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);
createRecordSets();
save();

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	appendFileEnabled Deprecated.
protected ExportToolDialog	guiInterface Deprecated.
protected boolean	multipleSelection Deprecated.
protected java.util.Map<java.lang.Enum,GRecordSet>	recordSets Deprecated.
protected java.util.Set<java.lang.Enum>	selectedExportOptions Deprecated.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	caretUpdate(javax.swing.event.CaretEvent evt) Deprecated.
void	createRecordSets() Deprecated. This method creates the different record sets depending on the selected export options.
protected abstract java.util.List<java.lang.Enum>	defineAvailableExportOptions() Deprecated. This method sets the available export options.
protected java.util.List<java.lang.Enum>	getAvailableExportOptions() Deprecated.
protected java.lang.String	getFilename() Deprecated.
protected java.util.Set<java.lang.Enum>	getSelectedExportOptions() Deprecated.
ExportToolDialog	getUI(java.awt.Container parent) Deprecated. This method returns the GUI interface of the class that implements this interface.
protected abstract ExportTool.InternalSwingWorkerForRecordSet	instantiateInternalSwingWorkerForRecordSet(java.lang.Enum selectedOption) Deprecated. This abstract method instantiates an InternalSwingWorkerForRecordSet-derived class, which is supposed to handle the construction of the GRecordSet instance.
protected boolean	isAppendFileEnabled() Deprecated.
boolean	isCanceled() Deprecated.
boolean	isVisible() Deprecated. This method returns true if the GUI is visible.
protected void	removeExportOption(java.lang.Enum exportOption) Deprecated. This method makes it possible to remove one export option if desired.
void	save() Deprecated. This method save the record set into a dbf file.
protected void	save(java.io.File file, java.lang.Enum exportOption) Deprecated.
void	setAppendFileEnabled(boolean appendFileEnabled) Deprecated.
protected void	setCanceled(boolean isCanceled) Deprecated.
void	setFilename(java.lang.String filename) Deprecated. This method sets the filename of the output file.
protected GRecordSet	setRecordSet(java.lang.Enum selectedOption) Deprecated. This method instantiates a InternalSwingWorkerForRecordSet-derived class, which handles the construction of the GRecordSet instance.
void	setSelectedOption(java.lang.Enum selectedOption) Deprecated.
void	setSelectedOptions(java.util.Set<java.lang.Enum> selectedOptions) Deprecated. This method sets the export options.
void	showUI(java.awt.Window parent) Deprecated. This method shows the GUI interface of the class that implements this interface.
void	valueChanged(javax.swing.event.ListSelectionEvent arg0) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

recordSets

protected java.util.Map<java.lang.Enum,GRecordSet> recordSets

Deprecated.

selectedExportOptions

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

Deprecated.

guiInterface

protected transient ExportToolDialog guiInterface

Deprecated.

multipleSelection

protected boolean multipleSelection

Deprecated.

appendFileEnabled

protected boolean appendFileEnabled

Deprecated.

Constructor Detail

ExportTool

protected ExportTool(boolean multipleSelection)

Deprecated.

General constructor.

Parameters:

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

ExportTool

protected ExportTool()

Deprecated.

General constructor with multiple selection mode set to false.

Method Detail

defineAvailableExportOptions

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

Deprecated.

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

setRecordSet

protected final GRecordSet setRecordSet(java.lang.Enum selectedOption)
                                 throws java.lang.Exception

Deprecated.

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 ExportTool.InternalSwingWorkerForRecordSet instantiateInternalSwingWorkerForRecordSet(java.lang.Enum selectedOption)

Deprecated.

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

Parameters:

selectedOption - the seleced output format

Returns:

the InternalSwingWorkerForRecordSet-derived instance

getSelectedExportOptions

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

Deprecated.

setSelectedOptions

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

Deprecated.

This method sets the export options. If the selectedOption Enum variable is not part of the available export options, an exception is thrown.

Parameters:

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

Throws:

java.lang.Exception

setSelectedOption

@Deprecated
public void setSelectedOption(java.lang.Enum selectedOption)
                                   throws java.lang.Exception

Deprecated.

This method sets the export option in case only one option is selected. The use of the setSelectedOptions is preferred to this method.

Parameters:

selectedOption - an Enum variable that represents the selected option

Throws:

java.lang.Exception

removeExportOption

protected void removeExportOption(java.lang.Enum exportOption)

Deprecated.

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()

Deprecated.

isAppendFileEnabled

protected boolean isAppendFileEnabled()

Deprecated.

setAppendFileEnabled

public void setAppendFileEnabled(boolean appendFileEnabled)

Deprecated.

setCanceled

protected void setCanceled(boolean isCanceled)

Deprecated.

isCanceled

public boolean isCanceled()

Deprecated.

setFilename

public void setFilename(java.lang.String filename)

Deprecated.

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()

Deprecated.

save

protected final void save(java.io.File file,
                          java.lang.Enum exportOption)
                   throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

save

public void save()
          throws java.lang.Exception

Deprecated.

This method save the record set into a dbf file. The filename must have been set previously.

Throws:

java.lang.Exception

getUI

public ExportToolDialog getUI(java.awt.Container parent)

Deprecated.

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)

Deprecated.

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)

Deprecated.

Specified by:

caretUpdate in interface javax.swing.event.CaretListener

valueChanged

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

Deprecated.

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

createRecordSets

public void createRecordSets()
                      throws java.lang.Exception

Deprecated.

This method creates the different record sets depending on the selected export options.

Throws:

java.lang.Exception

isVisible

public boolean isVisible()

Deprecated.

Description copied from interface: REpiceaUIObjectWithParent

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObjectWithParent

Returns:

a boolean