OperatorParameters

Abstract Value Members

abstract def contains(parameterId: String): Boolean

Find out whether or not the given parameter Id is contained in the object.
Find out whether or not the given parameter Id is contained in the object.
parameterId
The Id of the parameter that we want to search for.
returns
true if the parameter is contained. false otherwise.
abstract def getDoubleValue(parameterId: String): Double

Get the value of a parameter as a double.
Get the value of a parameter as a double.
parameterId
The parameter Id that was used with an input field in the OperatorDialog object.
returns
The parameter value as a double.
abstract def getIntValue(parameterId: String): Int

Get the value of a parameter as an integer.
Get the value of a parameter as an integer.
parameterId
The parameter Id that was used with an input field in the OperatorDialog object.
returns
The parameter value as an integer.
abstract def getParameterIds: Iterator[String]

Get an iterator of parameter Ids.
Get an iterator of parameter Ids.
returns
An iterator of parameter Ids.
abstract def getStringArrayValue(parameterId: String): Array[String]

Get the string array value of a parameter (a checkboxes parameter).
Get the string array value of a parameter (a checkboxes parameter).
parameterId
The parameter Id of the multi item selector (checkboxes).
returns
An array of selected values.
abstract def getStringValue(parameterId: String): String

Get the value of a parameter as a string.
Get the value of a parameter as a string.
parameterId
The parameter Id that was used with an input field in the OperatorDialog object.
returns
The parameter value as a string.
abstract def getTabularDatasetSelectedColumn(parameterId: String): (String, String)

Get the selected column from a tabular dataset output of an input operator.
Get the selected column from a tabular dataset output of an input operator. NOTE: If the parameter was not required and the user didn't select a column this will return an empty string.
parameterId
The parameter Id of the column dropdown dialog element.
returns
A tuple of a source operator name and a selected column name.
abstract def getTabularDatasetSelectedColumns(parameterId: String): (String, Array[String])

Get the selected columns from a tabular dataset output of an input operator.
Get the selected columns from a tabular dataset output of an input operator. NOTE: If the parameter was not required and the user did not input a value then this method will return and empty array.
parameterId
The parameter Id of the column checkboxes dialog element.
returns
A tuple of a source operator name and an array of selected column names.
abstract def getValue(parameterId: String): AnyRef

Get the value of a parameter as a reference object.
Get the value of a parameter as a reference object.
parameterId
The parameter Id that was used with an input field in the OperatorDialog object.
returns
The parameter value as a reference object.
abstract def operatorInfo: OperatorInfo

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 OperatorParameters extends AnyRef

Abstract Value Members

abstract def contains(parameterId: String): Boolean

abstract def getDoubleValue(parameterId: String): Double

abstract def getIntValue(parameterId: String): Int

abstract def getParameterIds: Iterator[String]

abstract def getStringArrayValue(parameterId: String): Array[String]

abstract def getStringValue(parameterId: String): String

abstract def getTabularDatasetSelectedColumn(parameterId: String): (String, String)

abstract def getTabularDatasetSelectedColumns(parameterId: String): (String, Array[String])

abstract def getValue(parameterId: String): AnyRef

abstract def operatorInfo: OperatorInfo

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