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

Class IridaWorkflowDescription

java.lang.Object

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

public class IridaWorkflowDescription
extends java.lang.Object

Class providing access to generic information about a workflow.

Constructor Summary

Constructors

Constructor	Description
IridaWorkflowDescription()
IridaWorkflowDescription(java.util.UUID id, java.lang.String name, java.lang.String version, AnalysisType analysisType, IridaWorkflowInput inputs, java.util.List<IridaWorkflowOutput> outputs, java.util.List<IridaWorkflowToolRepository> toolRepositories, java.util.List<IridaWorkflowParameter> parameters)	Generates a new IridaWorkflowDescription with the given information.

Method Summary

Modifier and Type	Method	Description
boolean	acceptsPairedSequenceFiles()	Whether or not this workflow accepts paired sequence files as input.
boolean	acceptsParameters()	Determines if this workflow accepts parameters.
boolean	acceptsSingleSequenceFiles()	Whether or not this workflow accepts single sequence files as input.
boolean	equals(java.lang.Object obj)
AnalysisType	getAnalysisType()
java.util.UUID	getId()
IridaWorkflowInput	getInputs()
java.lang.String	getName()
java.util.List<IridaWorkflowOutput>	getOutputs()
java.util.Map<java.lang.String,IridaWorkflowOutput>	getOutputsMap()	Gets a Map representation of the outputs of a workflow, linking the output name to the IridaWorkflowOutput entry.
java.util.List<IridaWorkflowParameter>	getParameters()
java.util.List<IridaWorkflowToolRepository>	getToolRepositories()
java.lang.String	getVersion()
int	hashCode()
boolean	requiresDynamicSource()	Whether or not this workflow requires a data from a dynamic source such as a Galaxy Tool Data Table.
boolean	requiresReference()	Whether or not this workflow requires a reference file.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IridaWorkflowDescription

public IridaWorkflowDescription()

IridaWorkflowDescription

public IridaWorkflowDescription(java.util.UUID id,
                                java.lang.String name,
                                java.lang.String version,
                                AnalysisType analysisType,
                                IridaWorkflowInput inputs,
                                java.util.List<IridaWorkflowOutput> outputs,
                                java.util.List<IridaWorkflowToolRepository> toolRepositories,
                                java.util.List<IridaWorkflowParameter> parameters)

Generates a new IridaWorkflowDescription with the given information.

Parameters:

id - The UUID for a workflow.

name - The name of the workflow.

version - The version of the workflow.

analysisType - The class type of the Analysis.

inputs - The inputs to the workflow.

outputs - The outputs to the workflow.

toolRepositories - The list of tools repositories for this workflow.

parameters - The valid parameters that can be modified for this workflow.

Method Detail

getId

public java.util.UUID getId()

getName

public java.lang.String getName()

getVersion

public java.lang.String getVersion()

requiresReference

public boolean requiresReference()

Whether or not this workflow requires a reference file.

Returns:

True if this workflow requires a reference file, false otherwise.

requiresDynamicSource

public boolean requiresDynamicSource()

Whether or not this workflow requires a data from a dynamic source such as a Galaxy Tool Data Table.

Returns:

True if this workflow requires a parameter value from a dynamic source.

acceptsSingleSequenceFiles

public boolean acceptsSingleSequenceFiles()

Whether or not this workflow accepts single sequence files as input.

Returns:

True if this workflow accepts single sequence files, false otherwise.

acceptsPairedSequenceFiles

public boolean acceptsPairedSequenceFiles()

Whether or not this workflow accepts paired sequence files as input.

Returns:

True if this workflow accepts paired sequence files, false otherwise.

getInputs

public IridaWorkflowInput getInputs()

getOutputs

public java.util.List<IridaWorkflowOutput> getOutputs()

getParameters

public java.util.List<IridaWorkflowParameter> getParameters()

getOutputsMap

public java.util.Map<java.lang.String,IridaWorkflowOutput> getOutputsMap()

Gets a Map representation of the outputs of a workflow, linking the output name to the IridaWorkflowOutput entry.

Returns:

A Map linking the output name to the IridaWorkflowOutput entry.

getToolRepositories

public java.util.List<IridaWorkflowToolRepository> getToolRepositories()

getAnalysisType

public AnalysisType getAnalysisType()

acceptsParameters

public boolean acceptsParameters()

Determines if this workflow accepts parameters.

Returns:

True if this workflow accepts, false otherwise.

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