Package com.atgenomix.seqslab.piper.plugin.api

Interface PiperValue

@DeveloperApi public interface PiperValue
An interface represents value of primitive types, e.g. Int, Double, or String, and object types, e.g. array, dictionary, or struct.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    PiperValue.Type
    Concrete types of all supported workflow parameters

  • Method Summary

    Modifier and Type
    Method
    Description
    default PiperValue[]
    getArray()
    Retrieve the value as an array of PiperValue.
    default Boolean
    getBoolean()
    Retrieve the value as a Boolean.
    default org.apache.commons.lang3.tuple.Pair<URI,org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>>
    getDataframe()
    Retrieve the value as a Pair of URL and its Spark Dataframe.
    default Map<String,PiperValue>
    getDictionary()
    Retrieve the value as a list of NamedValue objects with key as a String.
    default Double
    getDouble()
    Retrieve the value as a Double.
    default org.apache.commons.lang3.tuple.Pair<Path,Object>
    getFile()
    Retrieve the value as a Pair of path and SeqsLab DRS object.
    default Integer
    getInteger()
    Retrieve the value as an Integer.
    default String
    getString()
    Retrieve the value as a String.
    PiperValue.Type
    getType()
    Get the concrete type of this PiperValue object.

  • Method Details

    • getType

      PiperValue.Type getType()
      Get the concrete type of this PiperValue object.
      Returns:
      The concrete type

    • getBoolean

      default Boolean getBoolean()
      Retrieve the value as a Boolean.
      Returns:
      A Boolean value

    • getInteger

      default Integer getInteger()
      Retrieve the value as an Integer.
      Returns:
      An Integer value

    • getDouble

      default Double getDouble()
      Retrieve the value as a Double.
      Returns:
      A Double value

    • getString

      default String getString()
      Retrieve the value as a String.
      Returns:
      A String value

    • getFile

      default org.apache.commons.lang3.tuple.Pair<Path,Object> getFile()
      Retrieve the value as a Pair of path and SeqsLab DRS object.
      Returns:
      A Pair value representing a File

    • getArray

      default PiperValue[] getArray()
      Retrieve the value as an array of PiperValue.
      Returns:
      An array value

    • getDictionary

      default Map<String,PiperValue> getDictionary()
      Retrieve the value as a list of NamedValue objects with key as a String.
      Returns:
      A dictionary value

    • getDataframe

      default org.apache.commons.lang3.tuple.Pair<URI,org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>> getDataframe()
      Retrieve the value as a Pair of URL and its Spark Dataframe.
      Returns:
      A Pair value representing a dataframe