at.mug.iqm.core.workflow

Class ExecutionProxy

java.lang.Object

at.mug.iqm.core.workflow.ExecutionProxy

All Implemented Interfaces:

IExecutionProtocol

public class ExecutionProxy
extends Object
implements IExecutionProtocol

This class is the central control instance for launching operators in IQM via the GUI, i.e. the menu items.

Author:

Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.log4j.Logger	logger Custom class logger.
private MultiResultDialog	multiResultDialog The dialog for displaying the multiple results of an operator.
private IOperator	operator The operator (processing algorithm).
private IOperatorDescriptor	operatorDescriptor The descriptor.
private IOperatorGUI	operatorGUI The operator's GUI.
private String	operatorName The cached operator name.
private IOperatorValidator	operatorValidator The operator's validator.
private ParameterBlockIQM	pb The parameters of this protocol.
private Result	previewResult The preview result object of the protocol.
private int	state Set the default state to ExecutionState.IDLE.
private IWorkPackage	workPackage The work package of this protocol.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ExecutionProxy(String operatorName) The constructor always uses the name of the operator.

Method Summary

Modifier and Type	Method and Description
protected int	buildWorkPackage() Constructs a work package for an operator.
void	cancelProtocol()
void	disableInputs(AbstractOperatorGUI window) Sets a wait cursor to a JFrame and disables the inputs.
void	displayPreviewResults(Result result)
void	enableInputs(AbstractOperatorGUI window) Sets the default cursor to a JFrame and enables the inputs.
void	executeParallelProcessing(int nThreads) Executes the processing of all selected manager items in a parallel manner.
void	executePreview(IWorkPackage wp, IOperatorGUI opGUI) Executes a preview with the given work package and GUI.
void	executeSerialProcessing() Executes a serial stack processing task with the selected manager items.
void	finishProtocol() Clean up the the protocol and set the static instance to null for subsequent protocol executions.
private Vector<Object>	getAllSourcesForManager(int managerList) Gets all sources for the currently selected manager list into a Vector of IqmDataBoxes
static IExecutionProtocol	getCurrentInstance() Returns the current control instance for executing operators.
MultiResultDialog	getMultiResultDialog() Gets the Dialog for selecting multiple output results in order to add them to the Tank list.
IOperatorDescriptor	getOperatorDescriptor() Gets the operator descriptor of this protocol.
IOperatorGUI	getOperatorGUI() Gets the GUI of this protocol.
String	getOperatorName() Gets the name of the currently launched operator.
OperatorType	getOperatorType() Gets the type of the requested operator.
Result	getPreviewResult() Gets the preview result in the current execution protocol.
int	getState() Gets the current state of the protocol.
IWorkPackage	getWorkPackage() Gets the work package of this protocol.
protected int	initialize() Initializes all necessary classes and constructs instances of them.
static IExecutionProtocol	launchInstance(IOperatorDescriptor opDesc) This method launches a new instance of the IOperator specified by the given IOperatorDescriptor.
static IExecutionProtocol	launchInstance(String name) This method launches a new instance of the IOperator specified by the given name.
int	launchProtocol() Launch the protocol.
void	setPreviewResult(IResult previewResult) Sets the preview result in the current execution protocol.
void	setVirtualFlagToOperatorGUI(boolean virtual) Sets the "virtual" flag to the operator's GUI, if supported.
protected int	showOperatorGUI() Shows the requested operator GUI.
void	updateGUI() This method updates the operator GUI.
int[]	updateSources(int[] currMgrIdxs, int[] targetMgrIdxs) Updates the sources after items are changed in the manager and validates them again using the operator's validator.
protected int	validateWorkPackage() Validates the work package and sets the state of the protocol to ExecutionState.VALIDATING_PARAMETERS while the IOperatorValidator is validating.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.log4j.Logger logger

Custom class logger.

state

private int state

Set the default state to ExecutionState.IDLE.

operatorName

private String operatorName

The cached operator name.

operatorDescriptor

private IOperatorDescriptor operatorDescriptor

The descriptor.

operator

private IOperator operator

The operator (processing algorithm).

operatorGUI

private IOperatorGUI operatorGUI

The operator's GUI.

operatorValidator

private IOperatorValidator operatorValidator

The operator's validator.

workPackage

private IWorkPackage workPackage

The work package of this protocol.

previewResult

private Result previewResult

The preview result object of the protocol.

multiResultDialog

private MultiResultDialog multiResultDialog

The dialog for displaying the multiple results of an operator.

pb

private ParameterBlockIQM pb

The parameters of this protocol.

Constructor Detail

ExecutionProxy

private ExecutionProxy(String operatorName)

The constructor always uses the name of the operator.

Parameters:

operatorName - the unique name of the operator, located in the String[][] resources of the IOperatorDescriptor

Throws:

OperatorAlreadyOpenException - if another operator is already launched

Method Detail

launchInstance

public static IExecutionProtocol launchInstance(String name)
                                         throws UnknownOperatorException

This method launches a new instance of the IOperator specified by the given name.

Parameters:

name - the registered name of the operator

Returns:

the instance of the execution protocol

Throws:

UnknownOperatorException - if the operator is not found.

launchInstance

public static IExecutionProtocol launchInstance(IOperatorDescriptor opDesc)

This method launches a new instance of the IOperator specified by the given IOperatorDescriptor.

Parameters:

opDesc - the descriptor of the operator to be launched

Returns:

the instance of the execution protocol

getCurrentInstance

public static IExecutionProtocol getCurrentInstance()

Returns the current control instance for executing operators.

Returns:

the active control instance of ExecutionProxy, or null if the instance is not initialized

initialize

protected int initialize()

Initializes all necessary classes and constructs instances of them.

Returns:

ExecutionState.INITIALIZED if successful, ExecutionState.INITIALIZATION_FAILED otherwise

launchProtocol

public int launchProtocol()

Launch the protocol.

Specified by:

launchProtocol in interface IExecutionProtocol

Returns:

ExecutionState.FINISHED if no errors occur, ExecutionState.ERROR otherwise

buildWorkPackage

protected int buildWorkPackage()

Constructs a work package for an operator. The containing parameter block is a subclass of ParameterBlockIQM.

Returns:

ExecutionState.WORKPACKAGE_CONSTRUCTED if successful, ExecutionState.ERROR, if not

validateWorkPackage

protected int validateWorkPackage()

Validates the work package and sets the state of the protocol to ExecutionState.VALIDATING_PARAMETERS while the IOperatorValidator is validating.

Returns:

ExecutionState.VALIDATION_PASSED if successful, ExecutionState.VALIDATION_FAILED otherwise

showOperatorGUI

protected int showOperatorGUI()

Shows the requested operator GUI.

Returns:

ExecutionState.GUI_VISIBLE if successful, ExecutionState.ERROR otherwise

executePreview

public void executePreview(IWorkPackage wp,
                           IOperatorGUI opGUI)

Description copied from interface: IExecutionProtocol

Executes a preview with the given work package and GUI.

Specified by:

executePreview in interface IExecutionProtocol

executeSerialProcessing

public void executeSerialProcessing()

Executes a serial stack processing task with the selected manager items.

Specified by:

executeSerialProcessing in interface IExecutionProtocol

executeParallelProcessing

public void executeParallelProcessing(int nThreads)

Description copied from interface: IExecutionProtocol

Executes the processing of all selected manager items in a parallel manner. Every item will be processed with the same operator and parameters, but each item is processed in a separate thread. The number of threads is specified by nThreads.

Specified by:

executeParallelProcessing in interface IExecutionProtocol

Parameters:

nThreads - the number of threads that are supposed to run concurrently

disableInputs

public void disableInputs(AbstractOperatorGUI window)

Sets a wait cursor to a JFrame and disables the inputs.

Specified by:

disableInputs in interface IExecutionProtocol

Parameters:

window -

enableInputs

public void enableInputs(AbstractOperatorGUI window)

Sets the default cursor to a JFrame and enables the inputs.

Specified by:

enableInputs in interface IExecutionProtocol

Parameters:

window -

getState

public int getState()

Gets the current state of the protocol.

Returns:

the current state of the protocol.

getOperatorType

public OperatorType getOperatorType()

Gets the type of the requested operator.

Returns:

updateSources

public int[] updateSources(int[] currMgrIdxs,
                           int[] targetMgrIdxs)

Updates the sources after items are changed in the manager and validates them again using the operator's validator.

If validation fails, the source is set back to the original one when the operator was launched and the user is notified that the processing is not possible with the selected images.

Perform a reset of the sources by passing null for both parameters. This will yield a null value in return.

Specified by:

updateSources in interface IExecutionProtocol

Parameters:

currMgrIdxs - the currently selected cells

targetMgrIdxs - the manager list indexes to be selected after validation

Returns:

either the current indices, if updating fails, or the target indices, if it succeeds

updateGUI

public void updateGUI()
               throws Exception

This method updates the operator GUI.

Specified by:

updateGUI in interface IExecutionProtocol

Throws:

Exception

cancelProtocol

public void cancelProtocol()

finishProtocol

public void finishProtocol()

Clean up the the protocol and set the static instance to null for subsequent protocol executions.

Specified by:

finishProtocol in interface IExecutionProtocol

setVirtualFlagToOperatorGUI

public void setVirtualFlagToOperatorGUI(boolean virtual)

Description copied from interface: IExecutionProtocol

Sets the "virtual" flag to the operator's GUI, if supported.

Specified by:

setVirtualFlagToOperatorGUI in interface IExecutionProtocol

Parameters:

virtual - true, if the check box should be selected, false otherwise

getOperatorName

public String getOperatorName()

Description copied from interface: IExecutionProtocol

Gets the name of the currently launched operator.

Specified by:

getOperatorName in interface IExecutionProtocol

Returns:

the unique operator name specified in the String[][] resources with the key GlobalName

getWorkPackage

public IWorkPackage getWorkPackage()

Description copied from interface: IExecutionProtocol

Gets the work package of this protocol.

Specified by:

getWorkPackage in interface IExecutionProtocol

Returns:

the work package

getOperatorGUI

public IOperatorGUI getOperatorGUI()

Description copied from interface: IExecutionProtocol

Gets the GUI of this protocol.

Specified by:

getOperatorGUI in interface IExecutionProtocol

Returns:

the GUI

getOperatorDescriptor

public IOperatorDescriptor getOperatorDescriptor()

Description copied from interface: IExecutionProtocol

Gets the operator descriptor of this protocol.

Specified by:

getOperatorDescriptor in interface IExecutionProtocol

Returns:

the operator descriptor.

setPreviewResult

public void setPreviewResult(IResult previewResult)

Description copied from interface: IExecutionProtocol

Sets the preview result in the current execution protocol.

Specified by:

setPreviewResult in interface IExecutionProtocol

displayPreviewResults

public void displayPreviewResults(Result result)

getPreviewResult

public Result getPreviewResult()

Description copied from interface: IExecutionProtocol

Gets the preview result in the current execution protocol.

Specified by:

getPreviewResult in interface IExecutionProtocol

Returns:

the preview result instance

getMultiResultDialog

public MultiResultDialog getMultiResultDialog()

Description copied from interface: IExecutionProtocol

Gets the Dialog for selecting multiple output results in order to add them to the Tank list.

Specified by:

getMultiResultDialog in interface IExecutionProtocol

Returns:

a reference to the MultiResultDialog

getAllSourcesForManager

private Vector<Object> getAllSourcesForManager(int managerList)

Gets all sources for the currently selected manager list into a Vector of IqmDataBoxes

Parameters:

managerList - left list = 0, right list = 1

Returns:

the WorkPackage