com.alpine.plugin.core.utils

DBParameterUtils

object DBParameterUtils extends TableOutputParameterUtils

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DBParameterUtils
  2. TableOutputParameterUtils
  3. OutputParameterUtils
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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. 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
  7. 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
  8. def addOverwriteParameter(operatorDialog: OperatorDialog, defaultValue: Boolean = true): DialogElement

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

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

  11. def addViewOrTableRadioButton(operatorDialog: OperatorDialog): DialogElement

    Definition Classes
    TableOutputParameterUtils
  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def clone(): AnyRef

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

    Definition Classes
    TableOutputParameterUtils
  15. val defaultTableName: String

    Static values which will be used as parameter keys

    Static values which will be used as parameter keys

    Definition Classes
    TableOutputParameterUtils
  16. val dropIfExists: String

    Definition Classes
    OutputParameterUtils
  17. final def eq(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    AnyRef → Any
  21. 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

  22. 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
  23. 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

  24. 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
  25. 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

  26. def hashCode(): Int

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

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

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

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

    Definition Classes
    AnyRef
  31. val operatorNameUUIDVariable: String

    Definition Classes
    OutputParameterUtils
  32. val outputSchemaParameterId: String

    Definition Classes
    TableOutputParameterUtils
  33. val overwriteParameterID: String

    Definition Classes
    OutputParameterUtils
  34. val resultTableNameParameterID: String

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

    Definition Classes
    AnyRef
  36. val tableKey: String

    Definition Classes
    TableOutputParameterUtils
  37. def toString(): String

    Definition Classes
    AnyRef → Any
  38. val viewKey: String

    Definition Classes
    TableOutputParameterUtils
  39. val viewOrTableParameterKey: String

    Definition Classes
    TableOutputParameterUtils
  40. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. 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
  2. def addStandardDatabaseOutputParameters(operatorDialog: OperatorDialog, dataSourceManager: OperatorDataSourceManager, defaultOutputName: String = defaultTableName): Seq[DialogElement]

    Annotations
    @deprecated
    Deprecated

Inherited from TableOutputParameterUtils

Inherited from OutputParameterUtils

Inherited from AnyRef

Inherited from Any

Ungrouped