fr.cnes.genius.threads

Class GCommandLauncher

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.threads.GCommandLauncher

All Implemented Interfaces:

GDisplay, GListener, MouseWheelListener, EventListener

Direct Known Subclasses:

GJavaCommandLauncher

public class GCommandLauncher
extends GContainer
implements GDisplay, GListener

GCommandLauncher class defines a process that can be started or stopped by a button or a menu. This class includes a button object and a menu object in order to handle internally the two graphic components, button and menu, which represents the same process status. This class allows starting java or not-java-processes (class GJavaCommandLauncher is better adapted to launch java processes). The class takes into account the processes termination during the MMI application closure. Program execution progress may be observed via an object GProgressBar provided by object GCommandLauncher.

Author:

fourcadej

Default Constraint(s):

Index	Class	Item	Constraint
0	GExecButton	execButton	"newline"
1	GProgressBar	progressBar	"newline"
2	GExecMenuItem	execMenuItem	"newline"
3	GBufferedTextArea	bufferedTextArea	"newline" (see table below)

Default Constraint(s) for bufferedTextArea:

Index	Class	Item	Constraint
3, 0	GEntryInt	currentPageEntry	3, 0, 0, 0 => "newline , split 7 , alignx Right" 3, 0, 0, 1 => (null) 3, 0, 1 => "gapleft 4 , gapright 4 , gaptop 4 , gapbottom 4 , wmin 50 , wmax 50"
3, 1	GLabel	totalPageNumberLabel	"gapleft 4 , gapright 4 , gaptop 4 , gapbottom 4 , wmin 50"
3, 2	GButton	prevPageButton	(null)
3, 3	GButton	nextPageButton	(null)
3, 4	GToggleButton	realtimeButtton	(null)
3, 5	GTextArea	textArea	"newline , pushx , pushy , growx , growy"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GCommandLauncher.GCommandShutdownHookThread Hook that will be called to terminate the process and the associated treads in case the applications quit without closing the application.
class	GCommandLauncher.GExecButton Class representing a button linked to the GCommandLauncher.
class	GCommandLauncher.GExecMenuItem Class representing a menu item linked to the GCommandLauncher.
static class	GCommandLauncher.ProcessStatus Status of the underlying process.

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
GCommandLauncher(String[] commandArray, String runString, String stopString) Constructor.
GCommandLauncher(String[] commandArray, String runString, String stopString, GTextAreaInterface stdoutTextArea) Constructor.
GCommandLauncher(String[] commandArray, String runString, String stopString, GTextAreaInterface stdoutTextArea, GTextAreaInterface stderrTextArea) Constructor.
GCommandLauncher(String widgetId, String[] commandArray, String runString, String stopString) Constructor.
GCommandLauncher(String widgetId, String[] commandArray, String runString, String stopString, GTextAreaInterface stdoutTextArea) Constructor.
GCommandLauncher(String widgetId, String[] commandArray, String runString, String stopString, GTextAreaInterface stdoutTextArea, GTextAreaInterface stderrTextArea) Constructor.

Method Summary

Modifier and Type	Method and Description
void	after(GEvent e) Called after the event is processed.
void	before(GEvent e) Called before the event is processed.
protected void	clearProcessExitDetector() Nullify the process exit detector when it is not needed anymore.
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() The prototype of the generic function that shall exist in all the descendants.
int	getExitCode() Gets the return code of the program.
GCommandLauncher.GExecButton	getGExecButton() Get the GExecButton associated with the command launcher.
GCommandLauncher.GExecMenuItem	getGExecMenuItem() Get the GExecMenuItem associated with the command launcher.
GProgressBar	getGProgressBar() Get the GProgressBar associated with the command launcher.
boolean	getInhibited() Return the inhibits status
GCommandLauncher.ProcessStatus	getProcessStatus() Get the status of the process.
boolean	getResetTextAreaInterfaceOnRun() Get if the textAreaInterface shall be reset before each run.
GTextAreaInterface	getStderrGTextAreaInterface() Get the GTextAreaInterface associated with the command launcher stderr.
GTextAreaInterface	getStdoutGTextAreaInterface() Get the GTextAreaInterface associated with the command launcher stdout.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
boolean	isCopyOutputToStdout() Get if the stdout of the subprocess shall be copied to the stdout.
boolean	isRunning() Returns if the process is running.
void	launchStop() Launch or stop the process.
protected void	processFinished() Method called by the GProcessExitDetector when the process finishes.
protected void	processFinishedInvokeLater() Executes the processFinished method in the event loop through a runnable.
void	setButtonIcons(ImageIcon runIcon, ImageIcon stopIcon) Set the run and stop icons from the provided images.
void	setButtonIcons(int size) Set the run and stop icons from the default images contained in GIcon.
void	setButtonIcons(String runIconName, String stopIconName) Set the run and stop icons from the default images paths runIconName and stopIconName.
void	setCommandLine(String[] commandLine) Set the command line from the derived classes.
void	setCopyOutputToStdout(boolean copyOutputToStdout) Set if the stdout of the subprocess shall be copied to the stdout.
protected void	setDefaultConstraints() Set default constraints.
void	setEnabled(boolean flag) Set the enable status of the component.
void	setInhibited(boolean inhibited) Inhibits the launch and stop of the process, the inhibition is reseted after the processing of the event.
void	setMenuIcons(ImageIcon runIcon, ImageIcon stopIcon) Set the run and stop icons from the provided images.
void	setMenuIcons(int size) Set the run and stop icons from the default images contained in GIcon.
void	setMenuIcons(String runIconName, String stopIconName) Set the run and stop icons from the default images paths runIconName and stopIconName.
void	setResetTextAreaInterfaceOnRun(boolean resetTextAreaInterfaceOnRun) Set if the textAreaInterface shall be reset before each run.
protected void	setState(fr.cnes.genius.threads.GCommandLauncher.State state) Set the state of the button and menu icons, changing their icons and strings.
void	setStringConstraint(String constraint) Set the constraint in string format for the component.

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

put

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

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, 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

GCommandLauncher

public GCommandLauncher(String[] commandArray,
                        String runString,
                        String stopString)

Constructor. The widget identifier is automatically created.

Parameters:

commandArray - line of the program to launch when the exec() method is called.

runString - string to display in the menu and the button when the process is not running.

stopString - string to display in the menu and the button when the process is running.

GCommandLauncher

public GCommandLauncher(String[] commandArray,
                        String runString,
                        String stopString,
                        GTextAreaInterface stdoutTextArea)

Constructor. The widget identifier is automatically created.

Parameters:

commandArray - line of the program to launch when the exec() method is called.

runString - string to display in the menu and the button when the process is not running.

stopString - string to display in the menu and the button when the process is running.

stdoutTextArea - where the output stream from the underlying process are sent. If it is null both streams are sent to the standard output of the IHM. If the textArea is not a descendant of GComponent a runtime exception is thrown.

GCommandLauncher

public GCommandLauncher(String[] commandArray,
                        String runString,
                        String stopString,
                        GTextAreaInterface stdoutTextArea,
                        GTextAreaInterface stderrTextArea)

Constructor. The widget identifier is automatically created.

Parameters:

commandArray - line of the program to launch when the exec() method is called.

runString - string to display in the menu and the button when the process is not running.

stopString - string to display in the menu and the button when the process is running.

stdoutTextArea - where the output stream from the underlying process are sent. If it is null both streams are sent to the standard output of the IHM. If the textArea is not a descendant of GComponent a runtime exception is thrown.

stderrTextArea - where the error stream from the underlying process are sent. If it is null both streams are sent to the standard output of the IHM. If the textArea is not a descendant of GComponent a runtime exception is thrown.

GCommandLauncher

public GCommandLauncher(String widgetId,
                        String[] commandArray,
                        String runString,
                        String stopString)

Constructor.

Parameters:

widgetId - widget identifier.

commandArray - line of the program to launch when the exec() method is called.

runString - string to display in the menu and the button when the process is not running.

stopString - string to display in the menu and the button when the process is running.

GCommandLauncher

public GCommandLauncher(String widgetId,
                        String[] commandArray,
                        String runString,
                        String stopString,
                        GTextAreaInterface stdoutTextArea)

Constructor.

Parameters:

widgetId - widget identifier.

commandArray - line of the program to launch when the exec() method is called.

runString - string to display in the menu and the button when the process is not running.

stopString - string to display in the menu and the button when the process is running.

stdoutTextArea - where the output and error streams from the underlying process are sent. If it is null both streams are sent to the standard output of the IHM. If the textArea is not a descendant of GComponent a runtime exception is thrown.

GCommandLauncher

public GCommandLauncher(String widgetId,
                        String[] commandArray,
                        String runString,
                        String stopString,
                        GTextAreaInterface stdoutTextArea,
                        GTextAreaInterface stderrTextArea)

Constructor.

Parameters:

widgetId - widget identifier.

commandArray - line of the program to launch when the exec() method is called.

runString - string to display in the menu and the button when the process is not running.

stopString - string to display in the menu and the button when the process is running.

stdoutTextArea - where the output stream from the underlying process are sent. If it is null both streams are sent to the standard output of the IHM. If the textArea is not a descendant of GComponent a runtime exception is thrown.

stderrTextArea - where the error stream from the underlying process are sent. If it is null both streams are sent to the standard output of the IHM. If the textArea is not a descendant of GComponent a runtime exception is thrown.

Method Detail

setDefaultConstraints

protected void setDefaultConstraints()

Description copied from class: GComponent

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

setCommandLine

public void setCommandLine(String[] commandLine)

Set the command line from the derived classes.

Parameters:

commandLine - new command line.

clearProcessExitDetector

protected void clearProcessExitDetector()

Nullify the process exit detector when it is not needed anymore.

getGExecMenuItem

public GCommandLauncher.GExecMenuItem getGExecMenuItem()

Get the GExecMenuItem associated with the command launcher.

Returns:

the GExecMenuItem associated with the command launcher.

getGExecButton

public GCommandLauncher.GExecButton getGExecButton()

Get the GExecButton associated with the command launcher.

Returns:

the GExecButton associated with the command launcher.

getGProgressBar

public GProgressBar getGProgressBar()

Get the GProgressBar associated with the command launcher.

Returns:

the GProgressBar associated with the command launcher.

getStdoutGTextAreaInterface

public GTextAreaInterface getStdoutGTextAreaInterface()

Get the GTextAreaInterface associated with the command launcher stdout.

Returns:

the GTextAreaInterface associated with the command launcher stdout.

getStderrGTextAreaInterface

public GTextAreaInterface getStderrGTextAreaInterface()

Get the GTextAreaInterface associated with the command launcher stderr.

Returns:

the GTextAreaInterface associated with the command launcher stderr.

getExitCode

public int getExitCode()

Gets the return code of the program.

Returns:

the exit status of the program.

isRunning

public boolean isRunning()

Returns if the process is running.

Returns:

true if the process is running, false otherwise.

getProcessStatus

public GCommandLauncher.ProcessStatus getProcessStatus()

Get the status of the process.

Returns:

the status of the process.

launchStop

public void launchStop()

Launch or stop the process. If the process is running then stops it, else launch the process if the m_inhibate flag is not true.

processFinishedInvokeLater

protected void processFinishedInvokeLater()

Executes the processFinished method in the event loop through a runnable.

processFinished

protected void processFinished()

Method called by the GProcessExitDetector when the process finishes.

before

public void before(GEvent e)
            throws GException

Description copied from interface: GListener

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

Throws:

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

setEnabled

public void setEnabled(boolean flag)

Description copied from class: GComponent

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

after

public void after(GEvent e)
           throws GException

Description copied from interface: GListener

Called after the event is processed.

Specified by:

after in interface GListener

Parameters:

e - processed event.

Throws:

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

generic

public void generic()
             throws GException

Description copied from class: GContainer

The prototype of the generic function that shall exist in all the descendants.

Specified by:

generic in class GContainer

Throws:

GException - In case of problem.

setState

protected void setState(fr.cnes.genius.threads.GCommandLauncher.State state)

Set the state of the button and menu icons, changing their icons and strings.

Parameters:

state - new state of the menu and button.

setInhibited

public void setInhibited(boolean inhibited)

Inhibits the launch and stop of the process, the inhibition is reseted after the processing of the event.

Parameters:

inhibited - if the launch and stop of the process, the inhibition is reseted after the processing of the event.

setButtonIcons

public void setButtonIcons(int size)
                    throws GException

Set the run and stop icons from the default images contained in GIcon.

Parameters:

size - of the icons.

Throws:

GException - in case of problem loading the icons.

setButtonIcons

public void setButtonIcons(String runIconName,
                           String stopIconName)

Set the run and stop icons from the default images paths runIconName and stopIconName.

Parameters:

runIconName - name of the file containing the run icon.

stopIconName - name of the file containing the stop icon.

setButtonIcons

public void setButtonIcons(ImageIcon runIcon,
                           ImageIcon stopIcon)

Set the run and stop icons from the provided images.

Parameters:

runIcon - run icon object.

stopIcon - stop icon object.

setMenuIcons

public void setMenuIcons(int size)
                  throws GException

Set the run and stop icons from the default images contained in GIcon.

Parameters:

size - of the icons.

Throws:

GException - in case of problem loading the icons.

setMenuIcons

public void setMenuIcons(String runIconName,
                         String stopIconName)

Set the run and stop icons from the default images paths runIconName and stopIconName.

Parameters:

runIconName - name of the file containing the run icon.

stopIconName - name of the file containing the stop icon.

setMenuIcons

public void setMenuIcons(ImageIcon runIcon,
                         ImageIcon stopIcon)

Set the run and stop icons from the provided images.

Parameters:

runIcon - run icon object.

stopIcon - stop icon object.

display

public void display()
             throws GException

Description copied from interface: GDisplay

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.

setStringConstraint

public void setStringConstraint(String constraint)

Set the constraint in string format for the component.

Overrides:

setStringConstraint in class GComponent

Parameters:

constraint - constraint in string format to set for the component.

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

Parameters:

position - position of the requested component.

Returns:

the subcomponent occupying the position defined by position.

Throws:

GComponentException - in case the position argument is invalid.

setCopyOutputToStdout

public void setCopyOutputToStdout(boolean copyOutputToStdout)

Set if the stdout of the subprocess shall be copied to the stdout.

Parameters:

copyOutputToStdout - true if the subprocess output shall be copied to the stdout, false otherwise.

isCopyOutputToStdout

public boolean isCopyOutputToStdout()

Get if the stdout of the subprocess shall be copied to the stdout.

Returns:

true if the subprocess output shall be copied to the stdout, false otherwise.

setResetTextAreaInterfaceOnRun

public void setResetTextAreaInterfaceOnRun(boolean resetTextAreaInterfaceOnRun)

Set if the textAreaInterface shall be reset before each run.

Parameters:

resetTextAreaInterfaceOnRun - true if textAreaInterface shall be reset before each run, false otherwise.

getResetTextAreaInterfaceOnRun

public boolean getResetTextAreaInterfaceOnRun()

Get if the textAreaInterface shall be reset before each run.

Returns:

true if textAreaInterface shall be reset before each run, false otherwise.

getInhibited

public boolean getInhibited()

Return the inhibits status

Returns:

launch as not been launched if true.