Package ca.corefacility.bioinformatics.irida.model.workflow.description

Class IridaWorkflowParameter

java.lang.Object

ca.corefacility.bioinformatics.irida.model.workflow.description.IridaWorkflowParameter

public class IridaWorkflowParameter
extends java.lang.Object

Defines input parameters for a workflow which can be adjusted.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	IGNORE_DEFAULT_VALUE	Can be passed as the value of a parameter instructing IRIDA to ignore the default value.

Constructor Summary

Constructors

Constructor	Description
IridaWorkflowParameter()
IridaWorkflowParameter(java.lang.String name, boolean required, IridaWorkflowDynamicSourceGalaxy dynamicSource, java.util.List<IridaToolParameter> toolParameters)	Creates a new IridaWorkflowParameter which maps to the given tool parameters.
IridaWorkflowParameter(java.lang.String name, boolean required, java.util.List<IridaWorkflowParameterChoice> choices, java.util.List<IridaToolParameter> toolParameters)	Creates a new IridaWorkflowParameter which maps to the given tool parameters.
IridaWorkflowParameter(java.lang.String name, java.lang.String defaultValue, java.util.List<IridaToolParameter> toolParameters)	Creates a new IridaWorkflowParameter which maps to the given tool parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.List<IridaWorkflowParameterChoice>	getChoices()	Get the list of choices for this parameter
java.lang.String	getDefaultValue()	Gets the default value for this parameter.
IridaWorkflowDynamicSourceGalaxy	getDynamicSource()	Gets the dynamic source for the parameter.
java.lang.String	getName()	Gets the name of this parameter.
java.util.List<IridaToolParameter>	getToolParameters()	Gets a list of tools whose values are affected by this parameter.
java.lang.Boolean	hasChoices()	Does this parameter have a set of restricted choices?
java.lang.Boolean	hasDynamicSource()	Whether or not this parameter pulls its value from a Dynamic Source (eg.
int	hashCode()
java.lang.Boolean	isChoicesEmpty()	Is the list of choices empty?
boolean	isRequired()	Whether or not this parameter is required to be set manually before launching a pipeline.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

IGNORE_DEFAULT_VALUE

public static final java.lang.String IGNORE_DEFAULT_VALUE

Can be passed as the value of a parameter instructing IRIDA to ignore the default value.

See Also:

Constant Field Values

Constructor Detail

IridaWorkflowParameter

public IridaWorkflowParameter()

IridaWorkflowParameter

public IridaWorkflowParameter(java.lang.String name,
                              java.lang.String defaultValue,
                              java.util.List<IridaToolParameter> toolParameters)

Creates a new IridaWorkflowParameter which maps to the given tool parameters.

Parameters:

name - The name of the parameter.

defaultValue - The default value of this parameter.

toolParameters - The tool parameters corresponding to this named parameter.

IridaWorkflowParameter

public IridaWorkflowParameter(java.lang.String name,
                              boolean required,
                              IridaWorkflowDynamicSourceGalaxy dynamicSource,
                              java.util.List<IridaToolParameter> toolParameters)

Creates a new IridaWorkflowParameter which maps to the given tool parameters.

Parameters:

name - The name of the parameter.

required - The default value of this parameter.

dynamicSource - Any dynamic sources for parameters (eg. Galaxy Tool Data Table)

toolParameters - The tool parameters corresponding to this named parameter.

IridaWorkflowParameter

public IridaWorkflowParameter(java.lang.String name,
                              boolean required,
                              java.util.List<IridaWorkflowParameterChoice> choices,
                              java.util.List<IridaToolParameter> toolParameters)

Creates a new IridaWorkflowParameter which maps to the given tool parameters.

Parameters:

name - Parameter name.

required - Is the parameter required?

choices - Restricted set of choices for values of parameter.

toolParameters - Tool parameters for this named parameter.

Method Detail

getName

public java.lang.String getName()

Gets the name of this parameter.

Returns:

The name of this parameter.

getToolParameters

public java.util.List<IridaToolParameter> getToolParameters()

Gets a list of tools whose values are affected by this parameter.

Returns:

A List of tools whose values are affected by this parameter.

getDefaultValue

public java.lang.String getDefaultValue()

Gets the default value for this parameter.

Returns:

The default value for this parameter.

isRequired

public boolean isRequired()

Whether or not this parameter is required to be set manually before launching a pipeline.

Returns:

Boolean representing whether or not this parameter is required to be set manually before launching a pipeline.

getDynamicSource

public IridaWorkflowDynamicSourceGalaxy getDynamicSource()
                                                  throws IridaWorkflowParameterException

Gets the dynamic source for the parameter.

Returns:

The dynamic source for this parameter.

Throws:

IridaWorkflowParameterException - If multiple dynamic sources are associated with one parameter.

getChoices

public java.util.List<IridaWorkflowParameterChoice> getChoices()

Get the list of choices for this parameter

Returns:

list of choices for this parameter

hasDynamicSource

public java.lang.Boolean hasDynamicSource()

Whether or not this parameter pulls its value from a Dynamic Source (eg. a Galaxy Tool Data Table)

Returns:

Boolean representing whether or not this parameter has a dynamic source

hasChoices

public java.lang.Boolean hasChoices()

Does this parameter have a set of restricted choices?

Returns:

If this parameter has a list of choices

isChoicesEmpty

public java.lang.Boolean isChoicesEmpty()

Is the list of choices empty?

Returns:

if the list of choices is empty

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object