fr.cnes.genius.savefiles

Class GSaveResults

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.lowLevel.GDialog

fr.cnes.genius.savefiles.GSaveResults

All Implemented Interfaces:

GDisplay, GListener, MouseWheelListener, WindowListener, EventListener

public class GSaveResults
extends GDialog
implements GListener

Class to display a GDialog allowing to store results files and its associated context file.

Author:

goesterjf

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.lowLevel.GPanel

GPanel.Panel, GPanel.ScrollBarVisibility

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GSaveResults(String title, File exeFirstCurrentDirectory) Constructor.
GSaveResults(String title, File exeFirstCurrentDirectory, String resultFilesDotSuffix, String contextDotSuffix) Constructor.
GSaveResults(String widgetId, String title, File exeFirstCurrentDirectory) Constructor.
GSaveResults(String widgetId, String title, File exeFirstCurrentDirectory, String resultFilesDotSuffix, String contextDotSuffix) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addMultipleResultFile(String fileName, String suffixRex, String prefix, boolean needed) Add a multiple result file to the list of result files.
void	addSingleResultFile(String fileName, String prefix, boolean needed) Add a single result file.
void	addSingleResultFile(String fileName, String prefix, String dotSuffix, boolean needed) Add a single result file
void	after(GEvent eve) Method managing what occurs after action.
void	before(GEvent eve) Called before the event is processed.
void	clearResultFileList() Clear the result file list.
void	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
void	generic() Abstract generic function that need to be implemented by the descendants.
GSaveFileResultList	getResultList() Get the result list of the last save operation.
void	setContextFile(String fileName, String prefix, boolean needed) Set the context file.
protected void	setDefaultConstraints() set the defaults constraints
void	show() Show the dialog on the screen.

Methods inherited from class fr.cnes.genius.lowLevel.GDialog

dispose, getCancelled, getJDialog, hide, setMaximumSize, setMinimumSize, setPreferredSize, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class fr.cnes.genius.lowLevel.GPanel

clearConstraint, getClassConstraint, getComponent, getHorizontalScroll, getInnerDescendantClassConstraint, getJPanel, getJScrollPane, getLayoutConstraints, getStringClassConstraint, getVerticalScroll, mainClear, mainDisplay, processMouseWheelEvent, put, setClassConstraint, setColumnConstraints, setConstraint, setHorizontalScroll, setInnerDescendantClassConstraint, setLayoutConstraints, setMargins, setPanelConstraints, setPreferredSize, setRowConstraints, setUnitIncrement, setVerticalScroll, unput

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Constructor Detail

GSaveResults

public GSaveResults(String widgetId,
                    String title,
                    File exeFirstCurrentDirectory)

Constructor.

Parameters:

widgetId - widget identifier.

title - title of the panel.

exeFirstCurrentDirectory - current directory where to start for the first display.

GSaveResults

public GSaveResults(String title,
                    File exeFirstCurrentDirectory)

Constructor.

Parameters:

title - title of the panel.

exeFirstCurrentDirectory - current directory where to start for the first display.

GSaveResults

public GSaveResults(String title,
                    File exeFirstCurrentDirectory,
                    String resultFilesDotSuffix,
                    String contextDotSuffix)

Constructor.

Parameters:

title - title of the panel.

exeFirstCurrentDirectory - current directory where to start for the first display.

resultFilesDotSuffix - suffix (after dot) of the result files.

contextDotSuffix - suffix (after dot) of the context file.

GSaveResults

public GSaveResults(String widgetId,
                    String title,
                    File exeFirstCurrentDirectory,
                    String resultFilesDotSuffix,
                    String contextDotSuffix)

Constructor.

Parameters:

widgetId - widget identifier.

title - title of the panel.

exeFirstCurrentDirectory - current directory where to start for the first display.

resultFilesDotSuffix - suffix (after dot) of the result files.

contextDotSuffix - suffix (after dot) of the context file.

Method Detail

setDefaultConstraints

protected void setDefaultConstraints()

Description copied from class: GPanel

set the defaults constraints

Overrides:

setDefaultConstraints in class GPanel

setContextFile

public void setContextFile(String fileName,
                           String prefix,
                           boolean needed)

Set the context file.

Parameters:

fileName - initial file name (eventually using the absolute path).

prefix - prefix to be used for the final file name.

needed - indicates if the file is needed or optional.

clearResultFileList

public void clearResultFileList()

Clear the result file list.

addSingleResultFile

public void addSingleResultFile(String fileName,
                                String prefix,
                                boolean needed)

Add a single result file.

Parameters:

fileName - initial file name (eventually using the absolute path).

prefix - prefix to be used for the final file name.

needed - indicates if the file is needed or optional.

addSingleResultFile

public void addSingleResultFile(String fileName,
                                String prefix,
                                String dotSuffix,
                                boolean needed)

Add a single result file

Parameters:

fileName - initial file name (eventually using the absolute path).

prefix - prefix to be used for the final file name.

dotSuffix - suffix to be used for the final file name.

needed - indicates if the file is needed or optional.

addMultipleResultFile

public void addMultipleResultFile(String fileName,
                                  String suffixRex,
                                  String prefix,
                                  boolean needed)

Add a multiple result file to the list of result files.

Parameters:

fileName - initial file name glob expression.

suffixRex - regular expression to extract the suffix of the source file from the file name.

prefix - prefix to be used for the final file name.

needed - indicates if the file is needed or optional.

getResultList

public GSaveFileResultList getResultList()

Get the result list of the last save operation.

Returns:

the result list of the last save operation.

show

public void show()
          throws GException

Show the dialog on the screen.

Overrides:

show in class GDialog

Throws:

GException - in case of problem clearing the dialog.

display

public void display()
             throws GException

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

Throws:

GException - in case of problem while reading the value from file.

generic

public void generic()
             throws GException

Abstract generic function that need to be implemented by the descendants.

Specified by:

generic in class GPanel

Throws:

GException - in case of problem.

before

public void before(GEvent eve)
            throws GException

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

eve - event to processed.

Throws:

GException - in case there is a problem managing the event.

after

public void after(GEvent eve)
           throws GException

Method managing what occurs after action.

Specified by:

after in interface GListener

Parameters:

eve - GENIUS event.

Throws:

GException - GENIUS exception