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

Interface SupportsTableLocalization

All Superinterfaces:
AutoCloseable, Closeable, Executor, Operator, OperatorPipelineV3, Serializable, org.apache.spark.sql.api.java.UDF1<org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>,org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>>
@DeveloperApi @FeatureBeforeCall @FeatureAfterCall public interface SupportsTableLocalization extends Executor, org.apache.spark.sql.api.java.UDF1<org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>,org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>>
A mix-in interface for Executor. Executors can implement this interface to support DataFrame preprocessing for SQL command execution. If the File variable is defined as a Struct with fields in WDL, SeqsLab automatically renames table columns to the Struct field names. Executors implementing this mix-in interface is a user-defined function (UDF) that takes a DataFrame as an input parameter and returns a new DataFrame. This feature is invoked before and after applying Executor's call function.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Map<String,String>
    getProperties()
    Retrieves one or more NamedValue properties to set into the delta table.
    void
    setTableName(String name)
    Assign table name in the metastore using input dataframe's schema.

    Methods inherited from interface java.io.Closeable

    close

    Methods inherited from interface com.atgenomix.seqslab.piper.plugin.api.executor.Executor

    init

    Methods inherited from interface com.atgenomix.seqslab.piper.plugin.api.Operator

    getName, getOperatorContext

    Methods inherited from interface org.apache.spark.sql.api.java.UDF1

    call

  • Method Details

    • setTableName

      void setTableName(String name)
      Assign table name in the metastore using input dataframe's schema. This method is called before operator invocation.
      Parameters:
      name - Table name with namespace

    • getProperties

      default Map<String,String> getProperties()
      Retrieves one or more NamedValue properties to set into the delta table. This method is called after operator invocation.
      Returns:
      A map of properties as String