at.mug.iqm.api.operator

Interface IWorkPackage

All Superinterfaces:

Cloneable

All Known Implementing Classes:

WorkPackage

public interface IWorkPackage
extends Cloneable

This interface declares input parameters for a specific IOperator. An instance of IWorkPackage represents an encapsulated collection of parameters and sources in a subclass of ParameterBlockIQM. Furthermore the work package contains the operator instance to be executed by any execution thread.

During the parameter tweaking the ParameterBlockIQM is altered until the operator has to process this package and construct a IResult.

Author:

Philipp Kainz

Method Summary

Modifier and Type	Method and Description
void	addSource(Object source) Adds a single source to the end of the parameter's source list.
IWorkPackage	clone() Implements the protected Object.clone() method and returns a new reference to the clone of the object.
int	getIterations() Gets the integer flag indicating whether or not the algorithm (IOperator) associated with this work package should be executed more than once.
int[]	getManagerIndices() Gets the currently selected manager indices of this work package.
IOperator	getOperator() Get the IOperator associated with this work package.
ParameterBlockIQM	getParameters() Get the parameters and sources associated with this work package.
List<Object>	getSources() Gets all sources from the parameter block.
ParameterBlockIQM	getTemplate(String name) Get a predefined set of parameters for an operator which has been serialized to the template file.
boolean	isCustomComputationEnabled() Get a flag whether or not the operator should perform the computation of custom results.
boolean	isImageComputationEnabled() Get a flag whether or not the operator should perform the computation of image results.
boolean	isPlotComputationEnabled() Get a flag whether or not the operator should perform the computation of plot results.
boolean	isTableComputationEnabled() Get a flag whether or not the operator should perform the computation of table results.
void	removeSources() Remove all sources from the parameter block.
void	setCustomComputationEnabled(boolean customComputationEnabled) Set a flag for the operator whether or not the computation of custom results should be performed or not.
void	setImageComputationEnabled(boolean imageComputationEnabled) Set a flag for the operator whether or not the computation of image results should be performed or not.
void	setIterations(int n) Sets an integer flag determining whether or not the algorithm (IOperator) associated with this work package should be executed more than once.
void	setManagerIndices(int[] managerIndices) Sets the currently selected manager indices to this work package.
void	setOperator(IOperator operator) Set the IOperator to this work package.
void	setParameters(ParameterBlockIQM parameters) Set the parameters and sources to this work package.
void	setPlotComputationEnabled(boolean plotComputationEnabled) Set a flag for the operator whether or not the computation of plot results should be performed or not.
void	setSource(Object source, int index) Sets a single source to the parameter block.
void	setSources(List<Object> sources) Sets all sources to the parameter block.
void	setTableComputationEnabled(boolean tableComputationEnabled) Set a flag for the operator whether or not the computation of table results should be performed or not.
void	updateSource(Object source, int index) Updates sources in the parameter block.
void	updateSources(Vector<Object> sources) A method for updating the entire source list at once.

Method Detail

setOperator

void setOperator(IOperator operator)

Set the IOperator to this work package.

Parameters:

operator -

getOperator

IOperator getOperator()

Get the IOperator associated with this work package.

Returns:

the operator

getParameters

ParameterBlockIQM getParameters()

Get the parameters and sources associated with this work package.

Returns:

the ParameterBlockIQM

setParameters

void setParameters(ParameterBlockIQM parameters)

Set the parameters and sources to this work package.

Parameters:

parameters -

updateSources

void updateSources(Vector<Object> sources)

A method for updating the entire source list at once.

Parameters:

sources -

clone

IWorkPackage clone()

Implements the protected Object.clone() method and returns a new reference to the clone of the object.

Returns:

a cloned instance

Throws:

CloneNotSupportedException

See Also:

Object.clone()

removeSources

void removeSources()

Remove all sources from the parameter block.

getSources

List<Object> getSources()

Gets all sources from the parameter block.

Returns:

the Vector of objects

updateSource

void updateSource(Object source,
                  int index)
           throws NoSuchElementException

Updates sources in the parameter block.

If the source at the specified index is null, an NoSuchElementException will be thrown. If you need to set a new source use setSource(Object, int) instead.

Parameters:

source - the source object

index - the index position

Throws:

NoSuchElementException - if the requested index does not contain any element that can be updated

See Also:

setSource(Object, int)

setSources

void setSources(List<Object> sources)

Sets all sources to the parameter block.

Parameters:

sources - the source vector of objects

setSource

void setSource(Object source,
               int index)

Sets a single source to the parameter block.

The source at the specified index will be overwritten without any warning.

Parameters:

source - the source object

index - the position where to set the source to

addSource

void addSource(Object source)

Adds a single source to the end of the parameter's source list.

Parameters:

source - the source object

setIterations

void setIterations(int n)

Sets an integer flag determining whether or not the algorithm (IOperator) associated with this work package should be executed more than once. The number of executions is determined by parameter n.

The controlling IExecutionProtocol will be responsible for collecting all outputs before displaying them as a batch.

Parameters:

n - the number of iterations, an algorithm should run, or any value ≤1 for single iteration

getIterations

int getIterations()

Gets the integer flag indicating whether or not the algorithm (IOperator) associated with this work package should be executed more than once.

Returns:

the number of iterations, usually a value >1, or any value ≤1, if the operator should only run once

getManagerIndices

int[] getManagerIndices()

Gets the currently selected manager indices of this work package.

Returns:

the array, stored in the ParameterBlockIQM of this WorkPackage

See Also:

ParameterBlockIQM.getManagerIndices()

setManagerIndices

void setManagerIndices(int[] managerIndices)

Sets the currently selected manager indices to this work package.

Parameters:

managerIndices - the array of manager indices in this WorkPackage

See Also:

ParameterBlockIQM.setManagerIndices(int[])

setCustomComputationEnabled

void setCustomComputationEnabled(boolean customComputationEnabled)

Set a flag for the operator whether or not the computation of custom results should be performed or not.

This flag advises the algorithm to produce (partial) results.

Parameters:

customComputationEnabled -

isCustomComputationEnabled

boolean isCustomComputationEnabled()

Get a flag whether or not the operator should perform the computation of custom results.

Returns:

true if the flag is set, false otherwise

setTableComputationEnabled

void setTableComputationEnabled(boolean tableComputationEnabled)

Set a flag for the operator whether or not the computation of table results should be performed or not.

This flag advises the algorithm to produce (partial) results.

Parameters:

tableComputationEnabled -

isTableComputationEnabled

boolean isTableComputationEnabled()

Get a flag whether or not the operator should perform the computation of table results.

Returns:

true if the flag is set, false otherwise

setPlotComputationEnabled

void setPlotComputationEnabled(boolean plotComputationEnabled)

Set a flag for the operator whether or not the computation of plot results should be performed or not.

This flag advises the algorithm to produce (partial) results.

Parameters:

plotComputationEnabled -

isPlotComputationEnabled

boolean isPlotComputationEnabled()

Get a flag whether or not the operator should perform the computation of plot results.

Returns:

true if the flag is set, false otherwise

setImageComputationEnabled

void setImageComputationEnabled(boolean imageComputationEnabled)

Set a flag for the operator whether or not the computation of image results should be performed or not.

This flag advises the algorithm to produce (partial) results.

Parameters:

imageComputationEnabled -

isImageComputationEnabled

boolean isImageComputationEnabled()

Get a flag whether or not the operator should perform the computation of image results.

Returns:

true if the flag is set, false otherwise

getTemplate

ParameterBlockIQM getTemplate(String name)

Get a predefined set of parameters for an operator which has been serialized to the template file.

Parameters:

name - the unique name of the template for the associated operator

Returns:

a ParameterBlockIQM containing the template