com.alpine.plugin.core

OperatorMetadata

case class OperatorMetadata(name: String, category: String, author: String, version: Int, helpURL: String, iconNamePrefix: String) extends Product with Serializable

:: AlpineSdkApi :: Object that is returned by the "get metadata" method in the plugin signature class. And is used by the plugin engine to define how the operator will show up in the GUI.

name

the name of the operator as it shows up in the GUI

category

the category of operator i.e. "transformation". Used to filter operator in the left hand panel of the workflow GUI.

author

the writer of the operator

version

the version number of this operator.

helpURL

A link to documentation about the operator

iconNamePrefix

String name of the custom icon. To use the default icon, use the empty String.

Annotations
@AlpineSdkApi()
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OperatorMetadata
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OperatorMetadata(name: String, category: String, author: String, version: Int, helpURL: String, iconNamePrefix: String)

    create metadata class by defining each of its fields.

    create metadata class by defining each of its fields.

    name

    the name of the operator as it shows up in the GUI

    category

    the category of operator i.e. "transformation". Used to filter operator in the left hand panel of the workflow GUI.

    author

    the writer of the operator

    version

    the version number of this operator.

    helpURL

    A link to documentation about the operator

    iconNamePrefix

    String name of the custom icon. To use the default icon, use the empty String.

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. val author: String

    the writer of the operator

  8. val category: String

    the category of operator i.

    the category of operator i.e. "transformation". Used to filter operator in the left hand panel of the workflow GUI.

  9. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  11. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  13. val helpURL: String

    A link to documentation about the operator

  14. val iconNamePrefix: String

    String name of the custom icon.

    String name of the custom icon. To use the default icon, use the empty String.

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. val name: String

    the name of the operator as it shows up in the GUI

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

    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  21. val version: Int

    the version number of this operator.

  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped