com.alpine.plugin.core.dialog

OperatorDialog

trait OperatorDialog extends AnyRef

:: AlpineSdkApi :: This represents the operator parameter dialog window. The operator can add input UIs during registration.

Annotations
@AlpineSdkApi()
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OperatorDialog
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addAdvancedSparkSettingsBox(id: String, label: String, availableValues: List[SparkParameter]): DialogElement

  2. abstract def addCheckboxes(id: String, label: String, values: Seq[String], defaultSelections: Seq[String], required: Boolean = true): Checkboxes

    Add a button that opens a multiple checkbox dialog box.

    Add a button that opens a multiple checkbox dialog box.

    id

    String id of this input box.

    label

    The visual label of this input box.

    values

    Available checkbox values.

    defaultSelections

    Default selected checkboxes.

    required

    Whether the user is required to select a value for this parameter.

    returns

    A checkboxes element.

  3. abstract def addCheckboxesFromJavaList(id: String, label: String, values: List[String], defaultSelections: List[String], required: Boolean = true): Checkboxes

    Add a button that opens a multiple checkbox dialog box.

    Add a button that opens a multiple checkbox dialog box. This version is Java-friendly

    id

    String id of this input box.

    label

    The visual label of this input box.

    values

    Available checkbox values as java.util.List

    defaultSelections

    Default selected checkboxes.

    required

    Whether the user is required to select a value for this parameter.

    returns

    A checkboxes element.

  4. abstract def addChorusFileDropdownBox(id: String, label: String, extensionFilter: Set[String], isRequired: Boolean, linkText: Option[String]): ChorusFileDropdown

    id

    String id of dropdown box. This corresponds to the id for this parameter in OperatorsParameters.

    label

    The visual label of this dropdown box.

    extensionFilter

    e.g. Seq(.pynb) for python notebooks

    isRequired

    Whether the user is required to select a value for this parameter.

    linkText

    If specified, a link button with label textLink will show up at the bottom right of the dropdown selector. Clicking on this button will open a new browser tab with URL of the workfile selected.

    returns

    A ChorusFileDropdown element.

  5. abstract def addChorusFileDropdownBox(id: String, label: String, extensionFilter: Set[String], isRequired: Boolean): ChorusFileDropdown

    id

    String id of dropdown box. This corresponds to the id for this parameter in OperatorsParameters.

    label

    The visual label of this dropdown box.

    extensionFilter

    e.g. Seq(.pynb) for python notebooks

    isRequired

    Whether the user is required to select a value for this parameter.

    returns

    A ChorusFileDropdown element.

  6. abstract def addDBSchemaDropdownBox(id: String, label: String, defaultSchema: String): DBSchemaDropdownBox

    Add a schema selection box.

    Add a schema selection box. This can be used to select the schema for the output table location, etc. This will be a dropdown menu.

    id

    String id of this input box. This is used later to reference the value of this input box.

    label

    The visual label of this input box.

    defaultSchema

    The default value to be used in the input box.

    returns

    A DB schema dropdown box element.

  7. abstract def addDBTableDropdownBox(id: String, label: String, schemaBoxID: String): DBTableDropdownBox

    Add a table selection box.

    Add a table selection box. This can be used to select an existing table for an input or an output table.

    id

    String id of this input box. This is used later to reference the value of this input box.

    label

    The visual label of this input box.

    schemaBoxID

    The id of the schema dialog element, to know which

    returns

    A DB table dropdown box element.

  8. abstract def addDataSourceDropdownBox(id: String, label: String, dataSourceManager: OperatorDataSourceManager): DataSourceDropdownBox

    Add a data source selection box.

    Add a data source selection box. This can be used to select a particular data source if the workflow is associated with multiple data sources.

    id

    String id of this box. This is used later to reference the value of this input box.

    label

    This visual label of this input box.

    dataSourceManager

    The data source manager that contains the information about the available data sources as well as the chosen data source.

    returns

    A data source dropdown box element.

    Annotations
    @throws( classOf[Exception] )
    Exceptions thrown
    Exception

    It could throw an exception if the user tried to add more than one data source selection box to an operator dialog object.

  9. abstract def addDoubleBox(id: String, label: String, min: Double, max: Double, inclusiveMin: Boolean, inclusiveMax: Boolean, defaultValue: Double): DoubleBox

    Add a double text box.

    Add a double text box.

    id

    String id of this input box.

    label

    The visual label of this input box.

    min

    The minimum value.

    max

    The maximum value.

    inclusiveMin

    Whether the minimum is an inclusive value.

    inclusiveMax

    Whether the maximum is an inclusive value.

    defaultValue

    The default value for the double.

    returns

    A double box element.

  10. abstract def addDropdownBox(id: String, label: String, values: Seq[String], defaultSelection: String): DropdownBox

    Add a dropdown menu (a multiple choice input).

    Add a dropdown menu (a multiple choice input).

    id

    String id of this input box.

    label

    The visual label of this input box.

    values

    Available checkbox values.

    defaultSelection

    Default selected vale.

    returns

    A dropdown box element.

  11. abstract def addDropdownBoxFromJavaList(id: String, label: String, values: List[String], defaultSelection: String): DropdownBox

    Add a dropdown menu (a multiple choice input).

    Add a dropdown menu (a multiple choice input). This version is Java-friendly.

    id

    String id of this input box.

    label

    The visual label of this input box.

    values

    Available checkbox values from java.util.List

    defaultSelection

    Default selected vale.

    returns

    A dropdown box element.

  12. abstract def addHdfsDirectorySelector(id: String, label: String, defaultPath: String, isRequired: Boolean): HdfsFileSelector

    Add a Hdfs directory selection box.

    Add a Hdfs directory selection box. This can be used to select an Hdfs directory that already exists through an interactive selection window.

    id

    String id of this input box. This is used later to reference the value of this input box.

    label

    The visual label of this input box.

    defaultPath

    The default value to be used in the input box.

    isRequired

    - If the operator can be valid if this is left blank

    returns

    A Hdfs directory selection box element.

  13. abstract def addHdfsDirectorySelector(id: String, label: String, defaultPath: String): HdfsFileSelector

    Add a Hdfs directory selection box.

    Add a Hdfs directory selection box. This can be used to select an Hdfs directory that already exists through an interactive selection window.

    id

    String id of this input box. This is used later to reference the value of this input box.

    label

    The visual label of this input box.

    defaultPath

    The default value to be used in the input box.

    returns

    A Hdfs directory selection box element.

  14. abstract def addHdfsFileSelector(id: String, label: String, defaultPath: String, isRequired: Boolean): HdfsFileSelector

    Add a Hdfs file selection box.

    Add a Hdfs file selection box. This can be used to select an Hdfs file that already exists through an interactive selection window.

    id

    String id of this input box. This is used later to reference the value of this input box.

    label

    The visual label of this input box.

    defaultPath

    The default value to be used in the input box.

    isRequired

    - If the operator can be valid if this is left blank

    returns

    A Hdfs file selection box element.

  15. abstract def addHdfsFileSelector(id: String, label: String, defaultPath: String): HdfsFileSelector

    Add a Hdfs file selection box.

    Add a Hdfs file selection box. This can be used to select an Hdfs file that already exists through an interactive selection window.

    id

    String id of this input box. This is used later to reference the value of this input box.

    label

    The visual label of this input box.

    defaultPath

    The default value to be used in the input box.

    returns

    A Hdfs file selection box element.

  16. abstract def addIntegerBox(id: String, label: String, min: Int, max: Int, defaultValue: Int): IntegerBox

    Add an integer text box.

    Add an integer text box.

    id

    String id of this input box.

    label

    The visual label of this input box.

    min

    The minimum accepted value for the integer.

    max

    The maximum accepted value for the integer.

    defaultValue

    The default value for the integer.

    returns

    An integer box element.

  17. abstract def addLargeStringBox(id: String, label: String, defaultValue: String, regex: String, required: Boolean): StringBox

    Add a large string input box.

    Add a large string input box.

    id

    String id of this input box.

    label

    The visual label of this input box.

    defaultValue

    The default value in the string box.

    regex

    The regular expression constraint for the input box.

    required

    Boolean indicating whether the value must be non-empty.

    returns

    A string box element.

  18. abstract def addParentOperatorDropdownBox(id: String, label: String, required: Boolean): ParentOperatorDropdownBox

    Add a drop down box that can be used to select a parent operator name.

    Add a drop down box that can be used to select a parent operator name. This is useful to point to a particular parent's output for a particular use.

    id

    String id of this input box.

    label

    The visual label of this input box.

    required

    Whether the user is required to select a value for this parameter.

    returns

    A parent operator dropdown box.

  19. abstract def addParentOperatorDropdownBox(id: String, label: String): ParentOperatorDropdownBox

    Add a drop down box that can be used to select a parent operator name.

    Add a drop down box that can be used to select a parent operator name. This is useful to point to a particular parent's output for a particular use.

    Equivalent to label, true)

    id

    String id of this input box.

    label

    The visual label of this input box.

    returns

    A parent operator dropdown box.

  20. abstract def addPasswordBox(id: String, label: String, regex: String, required: Boolean): StringBox

    Add a string box that obfuscates the characters typed.

    Add a string box that obfuscates the characters typed. Note: In its current implementation, the passowrd cannot be seen in the UI, but is not in any other way more secure. The value of the password will still show up in a downloaded xml file.

    id

    String id of this input box.

    label

    The visual label of this input box.

    regex

    The regular expression constraint for the input box. Default is "+." (any char)

    required

    Boolean indicating whether the value must be non-empty.

    returns

  21. abstract def addRadioButtons(id: String, label: String, values: Seq[String], defaultSelection: String): RadioButtons

    Add a radio button input (a multiple choice input).

    Add a radio button input (a multiple choice input).

    id

    String id of this input box.

    label

    The visual label of this input box.

    values

    Available checkbox values

    defaultSelection

    Default selected button.

    returns

    A radio button element.

  22. abstract def addRadioButtonsFromJavaList(id: String, label: String, values: List[String], defaultSelection: String): RadioButtons

    Add a radio button input (a multiple choice input).

    Add a radio button input (a multiple choice input). This version is Java-friendly.

    id

    String id of this input box.

    label

    The visual label of this input box.

    values

    Available checkbox values as java.util.List

    defaultSelection

    Default selected button.

    returns

    A radio button element.

  23. abstract def addStringBox(id: String, label: String, defaultValue: String, regex: String, required: Boolean): StringBox

    Add a string input box.

    Add a string input box.

    id

    String id of this input box.

    label

    The visual label of this input box.

    defaultValue

    The default value in the string box.

    regex

    The regular expression constraint for the input box.

    required

    Boolean indicating whether the value must be non-empty.

    returns

    A string box element.

  24. abstract def addTabularDatasetColumnCheckboxes(id: String, label: String, columnFilter: ColumnFilter, selectionGroupId: String, required: Boolean, parentBoxId: Option[String]): TabularDatasetColumnCheckboxes

    Add a button for column checkboxes for a dataset input.

    Add a button for column checkboxes for a dataset input. This can be used to select multiple columns from a tabular dataset input. I.e., this will match tabular datasets coming in as inputs. In case of multiple dataset inputs, you'll need a separate column selector per dataset input (with a distinct parentBoxId).

    id

    String id for this parameter set.

    label

    The label (prefix) for this parameter set. In case there are multiple input datasets, each column selector button will be prefixed by this label.

    columnFilter

    Filter the columns that are selectable by their types.

    selectionGroupId

    If we want the available selections in this group to be dependent on other column selectors such that there's no duplicate selections, one could put multiple column selectors (checkboxes and/or dropboxes) in the same group.

    required

    Whether the user is required to select a value for this parameter.

    parentBoxId

    This parameter should be different from None if you have multiple dataset inputs. The Option value needs to be the id of a (required) ParentOperatorDropdownBox dialog element from which the dataset columns checkboxes will be generated according to the parent operator name selected.

    returns

    An input column checkboxes element.

  25. abstract def addTabularDatasetColumnCheckboxes(id: String, label: String, columnFilter: ColumnFilter, selectionGroupId: String, required: Boolean = true): TabularDatasetColumnCheckboxes

    Add a button for column checkboxes for a dataset input.

    Add a button for column checkboxes for a dataset input. This can be used to select multiple columns from a tabular dataset input. I.e., this will match tabular datasets coming in as inputs. In case of multiple dataset inputs, use the method with parameter parentBoxId.

    id

    String id for this parameter set.

    label

    The label (prefix) for this parameter set. In case there are multiple input datasets, each column selector button will be prefixed by this label.

    columnFilter

    Filter the columns that are selectable by their types.

    selectionGroupId

    If we want the available selections in this group to be dependent on other column selectors such that there's no duplicate selections, one could put multiple column selectors (checkboxes and/or dropboxes) in the same group.

    required

    Whether the user is required to select a value for this parameter.

    returns

    An input column checkboxes element.

  26. abstract def addTabularDatasetColumnDropdownBox(id: String, label: String, columnFilter: ColumnFilter, selectionGroupId: String, required: Boolean, parentBoxId: Option[String]): TabularDatasetColumnDropdownBox

    Add a column selector dropdown box for a dataset input.

    Add a column selector dropdown box for a dataset input. This can be used to select a single column from a tabular dataset. In case of multiple tabular dataset inputs, you'll need a separate column selector per dataset input (with a distinct parentBoxId).

    id

    String id for this parameter set.

    label

    The label (prefix) for this parameter set. In case there are multiple input datasets, each column selector button will be prefixed by this label.

    columnFilter

    Filter the columns that are selectable by their types.

    selectionGroupId

    If we want the available selections in this group to be dependent on other column selectors such that there's no duplicate selections, one could put multiple column selectors (checkboxes and/or dropboxes) in the same group.

    required

    Whether the user is required to select a value for this parameter.

    parentBoxId

    This parameter should be different from None if you have multiple dataset inputs. The Option value needs to be the id of a (required) ParentOperatorDropdownBox dialog element from which the dataset column dropdown will be generated according to the parent operator name selected.

    returns

    A single column selector dropdown box element.

  27. abstract def addTabularDatasetColumnDropdownBox(id: String, label: String, columnFilter: ColumnFilter, selectionGroupId: String, required: Boolean = true): TabularDatasetColumnDropdownBox

    Add a column selector dropdown box for a dataset input.

    Add a column selector dropdown box for a dataset input. This can be used to select a single column from a tabular dataset. In case of multiple dataset inputs, use the method with parameter parentBoxId.

    id

    String id for this parameter set.

    label

    The label (prefix) for this parameter set. In case there are multiple input datasets, each column selector button will be prefixed by this label.

    columnFilter

    Filter the columns that are selectable by their types.

    selectionGroupId

    If we want the available selections in this group to be dependent on other column selectors such that there's no duplicate selections, one could put multiple column selectors (checkboxes and/or dropboxes) in the same group.

    required

    Whether the user is required to select a value for this parameter.

    returns

    A single column selector dropdown box element.

  28. abstract def getDialogElement(id: String): DialogElement

    Get a dialog element by the Id.

    Get a dialog element by the Id.

    id

    The id of the dialog element that we want to retrieve.

    returns

    The matching dialog element.

  29. abstract def getDialogElements: Seq[DialogElement]

    Get an iterator of dialog elements.

    Get an iterator of dialog elements.

    returns

    The dialog elements.

  30. abstract def getLabel: String

    Get the label for this dialog box.

    Get the label for this dialog box.

    returns

    Get the label.

  31. abstract def addStringBox(id: String, label: String, defaultValue: String, regex: String, width: Int, height: Int): StringBox

    Add a string input box.

    Add a string input box.

    id

    String id of this input box.

    label

    The visual label of this input box.

    defaultValue

    The default value in the string box.

    regex

    The regular expression constraint for the input box.

    width

    Number of pixels for the width. 0 will use a default value.

    height

    Number of pixels for the height. 0 will use a default value.

    returns

    A string box element.

    Annotations
    @deprecated
    Deprecated

    Use addStringBox (without width and height parameters) or addLargeStringBox instead.

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped