Package com.experian.datastudio.sdk.api.step.configuration

Interface OutputColumnBuilderContext

public interface OutputColumnBuilderContext
The context for the output column builder of the custom step.
Since:
2.0.0

  • Method Details

    • getUserOption

      <T extends UserOption> T getUserOption()
      Gets the current user defined option.
      Type Parameters:
      T - The user option type.
      Returns:
      The user defined option.

    • getStepPropertyValue

      <T> Optional<T> getStepPropertyValue(String stepPropertyId)
      Convenience method to get arg value when the user option type is DefaultOption type.
      Type Parameters:
      T - The type of value the arg would return. e.g StringStepProperty would return String value.
      Parameters:
      stepPropertyId - the arg id
      Returns:
      The arg value.

    • createNewColumn

      Column createNewColumn(String columnName)
      Creates a new output column.
      Parameters:
      columnName - Name of output column
      Returns:
      Column object

    • getInputContext

      ConfigurationInputContext getInputContext(String inputId)
      Returns the configuration input context.
      Parameters:
      inputId - ID of the input context
      Returns:
      Configuration input context object

    • getColumnFromChooserValues

      List<Column> getColumnFromChooserValues(String columnChooserId)
      Convenience method to returns the columns selected by the user. It will returns empty list if the column chooser is invalid or the step property is not a column chooser.
      Parameters:
      columnChooserId - the column chooser's step property ID
      Returns:
      the list of selected Column

    • getStepSettingFieldValueAsString

      Optional<String> getStepSettingFieldValueAsString(String stepSettingFieldId)
      Returns the step setting field value as a string based on the step setting field ID specified.
      Parameters:
      stepSettingFieldId - ID of the step setting field to be returned
      Returns:
      String value of the step setting field
      Since:
      2.1.0