com.alpine.plugin.core

OperatorGUINode

abstract class OperatorGUINode[I <: IOBase, O <: IOBase] extends AnyRef

:: AlpineSdkApi :: Control the behavior of the operator GUI node within the editor.

Annotations
@AlpineSdkApi()
Linear Supertypes
AnyRef, Any
Known Subclasses
InferredSparkDataFrameGUINode, SparkDataFrameGUINode, TemplatedSparkDataFrameGUINode
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OperatorGUINode
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OperatorGUINode()

Abstract Value Members

  1. abstract def onPlacement(operatorDialog: OperatorDialog, operatorDataSourceManager: OperatorDataSourceManager, operatorSchemaManager: OperatorSchemaManager): Unit

    Define actions to be performed when the operator GUI node is placed in the workflow.

    Define actions to be performed when the operator GUI node is placed in the workflow. This involves defining the property dialog content and/or refining what the output schema is supposed to be like. E.g., if the output is a tabular dataset, provide some outline about the output schema (partial or complete).

    operatorDialog

    The operator dialog where the operator could add input text boxes, etc. to define UI for parameter inputs.

    operatorDataSourceManager

    Before executing the runtime of the operator the developer should determine the underlying platform that the runtime will execute against. E.g., it is possible for an operator to have accesses to two different Hadoop clusters or multiple databases. A runtime can run on only one platform. A default platform will be used if nothing is done.

    operatorSchemaManager

    This can be used to provide information about the nature of the output/input schemas. E.g., provide the output schema.

Concrete 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. def onInputOrParameterChange(inputSchemas: Map[String, TabularSchema], params: OperatorParameters, operatorSchemaManager: OperatorSchemaManager): OperatorStatus

    If there's a change in the inputs/connections or parameters then this function will get called so that the operator can redefine the input/output schema.

    If there's a change in the inputs/connections or parameters then this function will get called so that the operator can redefine the input/output schema.

    inputSchemas

    If the connected inputs contain tabular schemas, this is where they can be accessed, each with unique Ids.

    params

    The current parameter values to the operator.

    operatorSchemaManager

    This should be used to change the input/output schema, etc.

    returns

    A status object about whether the inputs and/or parameters are valid. The default implementation assumes that the connected inputs and/or parameters are valid.

  18. def onOutputVisualization(params: OperatorParameters, output: O, visualFactory: VisualModelFactory): VisualModel

    This is invoked for GUI to customize the operator output visualization after the operator finishes running.

    This is invoked for GUI to customize the operator output visualization after the operator finishes running. Each output should have associated default visualization, but the developer can customize it here.

    params

    The parameter values to the operator.

    output

    This is the output from running the operator.

    visualFactory

    For creating visual models.

    returns

    The visual model to be sent to the GUI for visualization.

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

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped