at.mug.iqm.api.operator

Class WorkPackage

java.lang.Object

at.mug.iqm.api.operator.WorkPackage

All Implemented Interfaces:

IWorkPackage, Cloneable

public class WorkPackage
extends Object
implements IWorkPackage

This is a ready-to-use implementation of IWorkPackage.

Author:

Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	customComputationEnabled A flag whether or not the operator should produce custom results.
protected boolean	imageComputationEnabled A flag whether or not the operator should produce image results.
protected int	iterations The number of iterations, the associated operator should run.
protected IOperator	operator The associated operator.
protected ParameterBlockIQM	parameters The parameters and sources.
protected boolean	plotComputationEnabled A flag whether or not the operator should produce plot results.
protected boolean	tableComputationEnabled A flag whether or not the operator should produce table results.

Constructor Summary

Constructors

Constructor and Description
WorkPackage() The default constructor.
WorkPackage(IOperator operator, ParameterBlockIQM pb) Constructs a new work package with the given parameters.

Method Summary

Modifier and Type	Method and Description
void	addSource(Object source) A convenient wrapper method for adding a source to the end of the source list.
WorkPackage	clone() Gets a copy of the object.
static WorkPackage	create(String operatorName) Creates a standard WorkPackage for a given operator including the operator and the standard parameter block.
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() A convenient wrapper method for getting the entire source list at once.
ParameterBlockIQM	getTemplate(String name) Get the a predefined template for the operator in this work package.
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.
IResult	process() Process the result of this work package.
void	removeSources() A convenient wrapper method for removing all sources.
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) A convenient wrapper method for setting a source to a specified index of the source list.
void	setSources(List<Object> sources) A convenient wrapper method for setting the entire source list at once.
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) A method for setting a source to a specified index of the source list.
void	updateSources(Vector<Object> sources) A method for updating the entire source list at once.

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected ParameterBlockIQM parameters

The parameters and sources.

operator

protected IOperator operator

The associated operator.

iterations

protected int iterations

The number of iterations, the associated operator should run. Default is 1, indicating, that the operator should only be executed once.

imageComputationEnabled

protected boolean imageComputationEnabled

A flag whether or not the operator should produce image results. Default is true.

plotComputationEnabled

protected boolean plotComputationEnabled

A flag whether or not the operator should produce plot results. Default is true.

tableComputationEnabled

protected boolean tableComputationEnabled

A flag whether or not the operator should produce table results. Default is true.

customComputationEnabled

protected boolean customComputationEnabled

A flag whether or not the operator should produce custom results. Default is true.

Constructor Detail

WorkPackage

public WorkPackage(IOperator operator,
                   ParameterBlockIQM pb)

Constructs a new work package with the given parameters.

Parameters:

operator - may be null

pb - must not be null

WorkPackage

public WorkPackage()

The default constructor.

Method Detail

getParameters

public ParameterBlockIQM getParameters()

Description copied from interface: IWorkPackage

Get the parameters and sources associated with this work package.

Specified by:

getParameters in interface IWorkPackage

Returns:

the parameters

setParameters

public void setParameters(ParameterBlockIQM parameters)

Description copied from interface: IWorkPackage

Set the parameters and sources to this work package.

Specified by:

setParameters in interface IWorkPackage

Parameters:

parameters - the parameters to set

getOperator

public IOperator getOperator()

Description copied from interface: IWorkPackage

Get the IOperator associated with this work package.

Specified by:

getOperator in interface IWorkPackage

Returns:

the operator

setOperator

public void setOperator(IOperator operator)

Description copied from interface: IWorkPackage

Set the IOperator to this work package.

Specified by:

setOperator in interface IWorkPackage

Parameters:

operator - the operator to set

getTemplate

public ParameterBlockIQM getTemplate(String name)

Get the a predefined template for the operator in this work package.

Specified by:

getTemplate in interface IWorkPackage

Parameters:

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

Returns:

a ParameterBlockIQM containing the template

addSource

public void addSource(Object source)

A convenient wrapper method for adding a source to the end of the source list.

This method wraps ParameterBlock.addSource(Object).

Specified by:

addSource in interface IWorkPackage

Parameters:

source -

setSource

public void setSource(Object source,
                      int index)

A convenient wrapper method for setting a source to a specified index of the source list.

This method wraps ParameterBlock.setSource(Object, int).

Specified by:

setSource in interface IWorkPackage

Parameters:

source -

index -

setSources

public void setSources(List<Object> sources)

A convenient wrapper method for setting the entire source list at once.

This method wraps ParameterBlock.setSources(Vector).

Specified by:

setSources in interface IWorkPackage

Parameters:

sources -

updateSources

public void updateSources(Vector<Object> sources)

A method for updating the entire source list at once.

Specified by:

updateSources in interface IWorkPackage

Parameters:

sources -

updateSource

public void updateSource(Object source,
                         int index)

A method for setting a source to a specified index of the source list.

Specified by:

updateSource in interface IWorkPackage

Parameters:

source -

index -

See Also:

IWorkPackage.setSource(Object, int)

getSources

public List<Object> getSources()

A convenient wrapper method for getting the entire source list at once.

This method wraps ParameterBlock.getSources().

Specified by:

getSources in interface IWorkPackage

Returns:

the source list

removeSources

public void removeSources()

A convenient wrapper method for removing all sources.

This method wraps ParameterBlock.removeSources().

Specified by:

removeSources in interface IWorkPackage

clone

public WorkPackage clone()

Gets a copy of the object.

Specified by:

clone in interface IWorkPackage

Overrides:

clone in class Object

Returns:

a cloned instance

See Also:

Object.clone()

create

public static WorkPackage create(String operatorName)

Creates a standard WorkPackage for a given operator including the operator and the standard parameter block.

Parameters:

operatorName - the unique name (identifier) of the operator

Returns:

a work package for an execution task

process

public IResult process()

Process the result of this work package.

Returns:

a multi-dimensional Result object

setIterations

public void setIterations(int n)

Description copied from interface: IWorkPackage

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.

Specified by:

setIterations in interface IWorkPackage

Parameters:

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

getIterations

public int getIterations()

Description copied from interface: IWorkPackage

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

Specified by:

getIterations in interface IWorkPackage

Returns:

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

getManagerIndices

public int[] getManagerIndices()

Description copied from interface: IWorkPackage

Gets the currently selected manager indices of this work package.

Specified by:

getManagerIndices in interface IWorkPackage

Returns:

the array, stored in the ParameterBlockIQM of this WorkPackage

See Also:

ParameterBlockIQM.getManagerIndices()

setManagerIndices

public void setManagerIndices(int[] managerIndices)

Description copied from interface: IWorkPackage

Sets the currently selected manager indices to this work package.

Specified by:

setManagerIndices in interface IWorkPackage

Parameters:

managerIndices - the array of manager indices in this WorkPackage

See Also:

ParameterBlockIQM.setManagerIndices(int[])

isImageComputationEnabled

public boolean isImageComputationEnabled()

Description copied from interface: IWorkPackage

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

Specified by:

isImageComputationEnabled in interface IWorkPackage

Returns:

true if the flag is set, false otherwise

setImageComputationEnabled

public void setImageComputationEnabled(boolean imageComputationEnabled)

Description copied from interface: IWorkPackage

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.

Specified by:

setImageComputationEnabled in interface IWorkPackage

isPlotComputationEnabled

public boolean isPlotComputationEnabled()

Description copied from interface: IWorkPackage

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

Specified by:

isPlotComputationEnabled in interface IWorkPackage

Returns:

true if the flag is set, false otherwise

setPlotComputationEnabled

public void setPlotComputationEnabled(boolean plotComputationEnabled)

Description copied from interface: IWorkPackage

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.

Specified by:

setPlotComputationEnabled in interface IWorkPackage

isTableComputationEnabled

public boolean isTableComputationEnabled()

Description copied from interface: IWorkPackage

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

Specified by:

isTableComputationEnabled in interface IWorkPackage

Returns:

true if the flag is set, false otherwise

setTableComputationEnabled

public void setTableComputationEnabled(boolean tableComputationEnabled)

Description copied from interface: IWorkPackage

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.

Specified by:

setTableComputationEnabled in interface IWorkPackage

isCustomComputationEnabled

public boolean isCustomComputationEnabled()

Description copied from interface: IWorkPackage

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

Specified by:

isCustomComputationEnabled in interface IWorkPackage

Returns:

true if the flag is set, false otherwise

setCustomComputationEnabled

public void setCustomComputationEnabled(boolean customComputationEnabled)

Description copied from interface: IWorkPackage

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.

Specified by:

setCustomComputationEnabled in interface IWorkPackage