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

Class IridaWorkflowInput

  • public class IridaWorkflowInput
extends java.lang.Object
    Defines the input labels for a workflow.

    • Constructor Summary

      Constructors 
      Constructor Description
      IridaWorkflowInput()  
      IridaWorkflowInput​(java.lang.String sequenceReadsSingle, java.lang.String sequenceReadsPaired, java.lang.String reference, boolean requiresSingleSample)
      Builds a new IridaWorkflowInput object with the given information.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.util.Optional<java.lang.String> getReference()
      Gets the reference label.
      java.util.Optional<java.lang.String> getSequenceReadsPaired()
      Gets the sequence reads paired label.
      java.util.Optional<java.lang.String> getSequenceReadsSingle()
      Gets the sequence reads single label.
      int hashCode()  
      boolean requiresSingleSample()
      Whether or not this workflow requires a single sample.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • IridaWorkflowInput

        public IridaWorkflowInput()

      • IridaWorkflowInput

        public IridaWorkflowInput​(java.lang.String sequenceReadsSingle,
                          java.lang.String sequenceReadsPaired,
                          java.lang.String reference,
                          boolean requiresSingleSample)
        Builds a new IridaWorkflowInput object with the given information.
        Parameters:
        sequenceReadsSingle - The label to use for a collection of single-end sequence reads. Null if no acceptance of single-end reads.
        sequenceReadsPaired - The label to use for a collection of paired-end sequence reads. Null if no acceptance of paired-end reads.
        reference - The label to use for a reference file.
        requiresSingleSample - Whether or not this workflow requires a single sample, or can work with multiple samples.

    • Method Detail

      • getSequenceReadsSingle

        public java.util.Optional<java.lang.String> getSequenceReadsSingle()
        Gets the sequence reads single label.
        Returns:
        The sequence reads single label, or Optional.empty() if no such label exists.

      • getReference

        public java.util.Optional<java.lang.String> getReference()
        Gets the reference label.
        Returns:
        The reference label, or Optional.empty() if no such label exists.

      • getSequenceReadsPaired

        public java.util.Optional<java.lang.String> getSequenceReadsPaired()
        Gets the sequence reads paired label.
        Returns:
        The sequence reads paired label, or Optional.empty() if no such label exists.

      • requiresSingleSample

        public boolean requiresSingleSample()
        Whether or not this workflow requires a single sample.
        Returns:
        True if this workflow requires a single sample, 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