Package gov.nih.mipav.model.scripting

Class ParsedActionLine

java.lang.Object
gov.nih.mipav.model.scripting.ParsedActionLine
public class ParsedActionLine extends Object
This object holds data parsed from a single line in a script, including the action to be taken and the parameters to pass to that action.

  • Field Details

    • action

      private String action
      The String representing the action which should be taken when this line is executed.

    • paramList

      private ParameterTable paramList
      A table of parameters which may/will be used when the action is performed.

  • Constructor Details

    • ParsedActionLine

      public ParsedActionLine(String newAction, ParameterTable newParamList)
      Creates a new ParsedActionLine object.
      Parameters:
      newAction - The String representing the action to be taken
      newParamList - The table of parameters which may/will be used when the action is performed

  • Method Details

    • convertToString

      public String convertToString()
      Returns this parsed action and its parameters in String form. May be used to write out the action line to a script.
      Returns:
      this parsed action and its parameters in String form

    • getAction

      public String getAction()
      Returns the action which should be taken when this line is executed.
      Returns:
      The String representing the action which should be taken when this line is executed.

    • getParameterCount

      public int getParameterCount()
      Returns the number of parameters which will be passed to this action.
      Returns:
      The number of parameters.

    • getParameterTable

      public ParameterTable getParameterTable()
      Returns the table of parameters which will be passed to this action when it is executed.
      Returns:
      The table of parameters to be used when this action is run.