Package fr.ens.biologie.genomique.eoulsan.galaxytools.elements

Class ConditionalToolElement

java.lang.Object
fr.ens.biologie.genomique.eoulsan.galaxytools.elements.ConditionalToolElement
All Implemented Interfaces:
ToolElement
public class ConditionalToolElement extends Object implements ToolElement
This class define a conditional tool element.
Since:
2.0
Author:
Sandrine Perrin

  • Field Details

  • Constructor Details

    • ConditionalToolElement

      public ConditionalToolElement(ToolInfo toolInfo, Element element) throws EoulsanException
      Instantiates a new tool conditional element.
      Parameters:
      toolInfo - the ToolInfo object
      element - the element
      Throws:
      EoulsanException - the eoulsan exception

  • Method Details

    • getName

      public String getName()
      Description copied from interface: ToolElement
      Gets the name.
      Specified by:
      getName in interface ToolElement
      Returns:
      the name

    • getShortName

      public String getShortName()
      Description copied from interface: ToolElement
      Gets the short name.
      Specified by:
      getShortName in interface ToolElement
      Returns:
      the short name

    • getValidatedName

      public String getValidatedName()
      Description copied from interface: ToolElement
      Gets the name which respect Eoulsan's syntax.
      Specified by:
      getValidatedName in interface ToolElement
      Returns:
      the name

    • getToolElementSelected

      public ToolElement getToolElementSelected()
      Gets the tool parameter selected.
      Returns:
      the tool parameter selected

    • getToolElementsResult

      public Map<String,ToolElement> getToolElementsResult()
      Gets the tool parameters result.
      Returns:
      the tool parameters result

    • isSet

      public boolean isSet()
      Test if the value has been set (if not the default value)
      Returns:
      true if the value has been set

    • getValue

      public String getValue()
      Description copied from interface: ToolElement
      Gets the value.
      Specified by:
      getValue in interface ToolElement
      Returns:
      the value

    • setValue

      public void setValue(String value)
      Description copied from interface: ToolElement
      Sets the value.
      Specified by:
      setValue in interface ToolElement
      Parameters:
      value - the value

    • setValues

      public void setValues(Map<String,Parameter> stepParameters) throws EoulsanException
      Set the values.
      Parameters:
      stepParameters - step parameters
      Throws:
      EoulsanException - if an error occurs while setting the values

    • toString

      public String toString()
      Overrides:
      toString in class Object