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 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

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

    Definition Classes
    OutputParameterUtils
  8. def addResultTableNameParameter(operatorDialog: OperatorDialog, defaultTableName: String = defaultTableName): DialogElement

    Definition Classes
    TableOutputParameterUtils
  9. def addStandardDatabaseOutputParameters(operatorDialog: OperatorDialog, dataSourceManager: OperatorDataSourceManager, defaultOutputName: String = operatorNameUUIDVariable): 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. -- "outputSchema": a drop down with all the defined schemas in the database, so that the user can pick their output schema. -- "viewOrTable": a radio button which lets the user choose whether to store the output as a view or a table -- "overwrite" : Inherited from the super class. A radio button so the user can select to delete the output table 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.

    dataSourceManager

    From the 'onExecution' method. Used to find the available schemas.

    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

  10. def addViewOrTableRadioButton(operatorDialog: OperatorDialog): DialogElement

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

    Definition Classes
    Any
  12. def clone(): AnyRef

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

    Definition Classes
    TableOutputParameterUtils
  14. val defaultTableName: String

    Definition Classes
    TableOutputParameterUtils
  15. final def eq(arg0: AnyRef): Boolean

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

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

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

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

  20. 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

  21. 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
  22. def getResultTableName(parameters: OperatorParameters): String

    Gets the value of the table name parameter.

    Gets the value of the table name parameter. Note: In in Postgress databases 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

  23. def hashCode(): Int

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

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

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

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

    Definition Classes
    AnyRef
  28. val operatorNameUUIDVariable: String

    Definition Classes
    OutputParameterUtils
  29. val outputSchemaParameterId: String

    Static values which will be used as parameter keys

  30. val overwriteParameterID: String

    Definition Classes
    OutputParameterUtils
  31. val resultTableNameParameterID: String

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

    Definition Classes
    AnyRef
  33. val tableKey: String

    Definition Classes
    TableOutputParameterUtils
  34. def toString(): String

    Definition Classes
    AnyRef → Any
  35. val viewKey: String

    Definition Classes
    TableOutputParameterUtils
  36. val viewOrTableParameterKey: String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TableOutputParameterUtils

Inherited from OutputParameterUtils

Inherited from AnyRef

Inherited from Any

Ungrouped