lerfob.carbonbalancetool.io

Class CATExportTool

java.lang.Object

repicea.io.tools.REpiceaExportTool

lerfob.carbonbalancetool.io.CATExportTool

All Implemented Interfaces:

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

public class CATExportTool
extends REpiceaExportTool

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CATExportTool.ExportOption

Nested classes/interfaces inherited from class repicea.io.tools.REpiceaExportTool

REpiceaExportTool.FieldName, REpiceaExportTool.InternalSwingWorkerForRecordSet

Field Summary

Fields inherited from class repicea.io.tools.REpiceaExportTool

appendFileEnabled, guiInterface, multipleSelection, saveFileEnabled, selectedExportOptions

Constructor Summary

Constructors

Constructor and Description
CATExportTool(SettingMemory memorySettings, CATSimulationResult summary) Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.Vector<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 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.
java.util.List<java.lang.Enum>	setAllAvailableOptions() This method sets the selected options to all the possible options.
void	setSaveFileEnabled(boolean bool) This method makes it possible to disable the saving to file.

Methods inherited from class repicea.io.tools.REpiceaExportTool

caretUpdate, createRecordSets, getFilename, getSelectedExportOptions, getUI, isAppendFileEnabled, isCanceled, isVisible, removeExportOption, setAppendFileEnabled, setCanceled, setFilename, setMultipleSelection, setSelectedOptions, showUI, valueChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

CATExportTool

public CATExportTool(SettingMemory memorySettings,
                     CATSimulationResult summary)
              throws java.lang.Exception

Constructor.

Parameters:

summary - a CarbonAccountingToolExportSummary instance

Throws:

java.lang.Exception

Method Detail

setSaveFileEnabled

public void setSaveFileEnabled(boolean bool)

Description copied from class: REpiceaExportTool

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

Overrides:

setSaveFileEnabled in class REpiceaExportTool

Parameters:

bool - a boolean

exportRecordSets

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

Description copied from class: REpiceaExportTool

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.

Overrides:

exportRecordSets in class REpiceaExportTool

Returns:

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

Throws:

java.lang.Exception

defineAvailableExportOptions

protected java.util.Vector<java.lang.Enum> defineAvailableExportOptions()

Description copied from class: REpiceaExportTool

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

Specified by:

defineAvailableExportOptions in class REpiceaExportTool

Returns:

a vector that contains the different export options

getAvailableExportOptions

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

Overrides:

getAvailableExportOptions in class REpiceaExportTool

instantiateInternalSwingWorkerForRecordSet

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

Description copied from class: REpiceaExportTool

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

Specified by:

instantiateInternalSwingWorkerForRecordSet in class REpiceaExportTool

Parameters:

selectedOption - the selected output format

recordSet - a REpiceaRecordSet instance

Returns:

the InternalSwingWorkerForRecordSet-derived instance

setAllAvailableOptions

public java.util.List<java.lang.Enum> setAllAvailableOptions()
                                                      throws java.lang.Exception

This method sets the selected options to all the possible options. It is typically called by external applications.

Throws:

java.lang.Exception