DBParameterUtils

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
def addDBSchemaDropDownBox(operatorDialog: OperatorDialog, defaultSchema: String = defaultDatabaseName): DialogElement

Use in the GUINode: Adds the schema drop down box, "outputSchema" to the operatorDialog and returns the DialogElement
Use in the GUINode: Adds the schema drop down box, "outputSchema" to the operatorDialog and returns the DialogElement

Definition Classes
TableOutputParameterUtils
def addDropIfExistsParameter(operatorDialog: OperatorDialog, defaultValue: Boolean = true): DialogElement

For use with database, not HDFS.
For use with database, not HDFS.
operatorDialog
From the 'onExecution' method's parameters. This method adds the parameters to this object.
defaultValue
boolean indicating default value of the parameter. True for "Yes", false for "No".
returns
The dialog element added.

Definition Classes
OutputParameterUtils
def addOverwriteParameter(operatorDialog: OperatorDialog, defaultValue: Boolean = true): DialogElement

Definition Classes
OutputParameterUtils
def addResultTableNameParameter(operatorDialog: OperatorDialog, defaultTableName: String = defaultTableName, label: String = "Result Table Name"): DialogElement

Definition Classes
TableOutputParameterUtils
def addStandardDBOutputParameters(operatorDialog: OperatorDialog, defaultOutputName: String = defaultTableName): Seq[DialogElement]

Adds parameters to your operator to allow the user to determine how the output of the database operator will be written.
Adds parameters to your operator to allow the user to determine how the output of the database operator will be written. This method adds the following parameters. -- "viewOrTable": a radio button which lets the user choose whether to store the output as a view or a table -- "outputSchema": a drop down with all the defined schemas in the database, so that the user can pick their output schema. -- "dropIfExists" : Inherited from the super class. A radio button so the user can select to drop the output table/view if it already exists or throw an exception. -- "outputName" : The name of the output table. The default is the userID+the workflow name + the operator UUID
operatorDialog
From the 'onExecution' method's parameters. This method adds the parameters to this object.
defaultOutputName
Optional. If you would like the default output to be something other than "tmpTable"
returns
A sequence of each of the parameters that were created and added to the operatorDialog
def addViewOrTableRadioButton(operatorDialog: OperatorDialog): DialogElement

Definition Classes
TableOutputParameterUtils
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val defaultDatabaseName: String

Definition Classes
TableOutputParameterUtils
val defaultTableName: String

Static values which will be used as parameter keys
Static values which will be used as parameter keys

Definition Classes
TableOutputParameterUtils
val dropIfExists: String

Definition Classes
OutputParameterUtils
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 getDBOutputSchemaParam(parameters: OperatorParameters): String

Use in the runtime class: Gets the value of "outputSchema" parameter
Use in the runtime class: Gets the value of "outputSchema" parameter
parameters
OperatorParameters instance [containing the "outputSchema" parameter].
returns
the output schema name

Annotations
@throws( classOf[NullPointerException] )
Exceptions thrown
java.lang.NullPointerException if the parameter wasn't added to the parameters object
def getDropIfExistsParameterValue(parameters: OperatorParameters): Boolean

Gets the value of the dropIfExists parameter, returning true if the String value is "Yes", false if it is a different value or missing.
Gets the value of the dropIfExists parameter, returning true if the String value is "Yes", false if it is a different value or missing.
parameters
OperatorParameters instance [containing the dropIfExists parameter].
returns
Boolean representation of the dropIfExists parameter.

Definition Classes
OutputParameterUtils
def getIsViewParam(parameters: OperatorParameters): Boolean

Use in the runtime class: Gets the value of "isViewOrTable" parameter and returns true if the user set the radio button to "view"
Use in the runtime class: Gets the value of "isViewOrTable" parameter and returns true if the user set the radio button to "view"
parameters
OperatorParameters instance [containing the "viewOrTable" parameter].
returns
if the user selected "view"

Definition Classes
TableOutputParameterUtils
Annotations
@throws( classOf[NullPointerException] )
Exceptions thrown
java.lang.NullPointerException if the parameter wasn't added to the parameters object
def getOverwriteParameterValue(parameters: OperatorParameters): Boolean

Gets the value of the overwrite parameter, returning true if the String value is "true", false if it is a different value or missing.
Gets the value of the overwrite parameter, returning true if the String value is "true", false if it is a different value or missing.
parameters
OperatorParameters instance [containing the overwrite parameter].
returns
Boolean representation of the overwrite parameter.

Definition Classes
OutputParameterUtils
def getResultTableName(parameters: OperatorParameters): String

Gets the value of the table name parameter.
Gets the value of the table name parameter. Note: In in PostgresSQL database names containing capital letters will need to be double quoted.
parameters
OperatorParameters instance [containing the "resultTableName" parameter].
returns
the output table name

Definition Classes
TableOutputParameterUtils
Annotations
@throws( classOf[NullPointerException] )
Exceptions thrown
java.lang.NullPointerException if the parameter wasn't added to the parameters object
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
val operatorNameUUIDVariable: String

Definition Classes
OutputParameterUtils
val outputSchemaParameterId: String

Definition Classes
TableOutputParameterUtils
val overwriteParameterID: String

Definition Classes
OutputParameterUtils
val resultTableNameParameterID: String

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

Definition Classes
AnyRef
val tableKey: String

Definition Classes
TableOutputParameterUtils
def toString(): String

Definition Classes
AnyRef → Any
val viewKey: String

Definition Classes
TableOutputParameterUtils
val viewOrTableParameterKey: String

Definition Classes
TableOutputParameterUtils
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( ... )

Deprecated Value Members

def addDBSchemaDropDown(operatorDialog: OperatorDialog, operatorDataSourceManager: OperatorDataSourceManager, defaultSchema: String = defaultDatabaseName): DialogElement

Use in the GUINode: Adds the schema drop down box, "outputSchema" to the operatorDialog and returns the DialogElement
Use in the GUINode: Adds the schema drop down box, "outputSchema" to the operatorDialog and returns the DialogElement

Definition Classes
TableOutputParameterUtils
Annotations
@deprecated
Deprecated
def addStandardDatabaseOutputParameters(operatorDialog: OperatorDialog, dataSourceManager: OperatorDataSourceManager, defaultOutputName: String = defaultTableName): Seq[DialogElement]

Annotations
@deprecated
Deprecated

Related Doc: package utils

object DBParameterUtils extends TableOutputParameterUtils

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addDBSchemaDropDownBox(operatorDialog: OperatorDialog, defaultSchema: String = defaultDatabaseName): DialogElement

def addDropIfExistsParameter(operatorDialog: OperatorDialog, defaultValue: Boolean = true): DialogElement

def addOverwriteParameter(operatorDialog: OperatorDialog, defaultValue: Boolean = true): DialogElement

def addResultTableNameParameter(operatorDialog: OperatorDialog, defaultTableName: String = defaultTableName, label: String = "Result Table Name"): DialogElement

def addStandardDBOutputParameters(operatorDialog: OperatorDialog, defaultOutputName: String = defaultTableName): Seq[DialogElement]

def addViewOrTableRadioButton(operatorDialog: OperatorDialog): DialogElement

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultDatabaseName: String

val defaultTableName: String

val dropIfExists: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getDBOutputSchemaParam(parameters: OperatorParameters): String

def getDropIfExistsParameterValue(parameters: OperatorParameters): Boolean

def getIsViewParam(parameters: OperatorParameters): Boolean

def getOverwriteParameterValue(parameters: OperatorParameters): Boolean

def getResultTableName(parameters: OperatorParameters): String

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val operatorNameUUIDVariable: String

val outputSchemaParameterId: String

val overwriteParameterID: String

val resultTableNameParameterID: String

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

val tableKey: String

def toString(): String

val viewKey: String

val viewOrTableParameterKey: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

def addDBSchemaDropDown(operatorDialog: OperatorDialog, operatorDataSourceManager: OperatorDataSourceManager, defaultSchema: String = defaultDatabaseName): DialogElement

def addStandardDatabaseOutputParameters(operatorDialog: OperatorDialog, dataSourceManager: OperatorDataSourceManager, defaultOutputName: String = defaultTableName): Seq[DialogElement]

Inherited from TableOutputParameterUtils

Inherited from OutputParameterUtils

Inherited from AnyRef

Inherited from Any

Ungrouped