OperatorDialog

Abstract Value Members

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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
abstract def addChildOperatorDialog(label: String): OperatorDialog

Add a button that will open a child dialog box to this one.
Add a button that will open a child dialog box to this one.
label
The label for the child dialog box button.
returns
A new child dialog object.

Annotations
@Disabled()
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
abstract def addDBTableDropdownBox(id: String, label: String, defaultTable: 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.
defaultTable
The default value to be used in the input box.
returns
A DB table dropdown box element.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
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.
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
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.
id
String id of this input box.
label
The visual label of this input box.
returns
A parent operator dropdown box.
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
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
@throws( classOf[Exception] )
Exceptions thrown
Exception
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, there'll be a separate column selector per dataset input.
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
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 tabular dataset inputs, there'll be a separate column selector per dataset input.
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.

Annotations
@throws( classOf[Exception] )
Exceptions thrown
Exception
abstract def getChildOperatorDialogs(): Iterator[OperatorDialog]

Get an iterator of child operator dialogs.
Get an iterator of child operator dialogs.
returns
An iterator of child operator dialogs.

Annotations
@Disabled()
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.
abstract def getDialogElements(): Iterator[DialogElement]

Get an iterator of dialog elements.
Get an iterator of dialog elements.
returns
An iterator of dialog elements.
abstract def getLabel(): String

Get the label for this dialog box.
Get the label for this dialog box.
returns
Get the label.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

trait OperatorDialog extends AnyRef

Abstract Value Members

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

abstract def addChildOperatorDialog(label: String): OperatorDialog

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

abstract def addDBTableDropdownBox(id: String, label: String, defaultTable: String): DBTableDropdownBox

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

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

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

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

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

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

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

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

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

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

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

abstract def getChildOperatorDialogs(): Iterator[OperatorDialog]

abstract def getDialogElement(id: String): DialogElement

abstract def getDialogElements(): Iterator[DialogElement]

abstract def getLabel(): String

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped