Class/Object

com.alpine.plugin.core

OperatorMetadata

Related Docs: object OperatorMetadata | package core

Permalink

case class OperatorMetadata(name: String, category: String, author: Option[String], version: Int, helpURL: Option[String], icon: Option[OperatorIcon], toolTipText: Option[String], usesJavascript: Boolean) 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

icon

Name and shape of the custom icon. To use the default icon, use Option.empty().

toolTipText

The text of the tool tip which appears when the user hovers over the icon for the operator in the left hand "operators" dropdown.

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
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OperatorMetadata(name: String, category: String, version: Int = 1)

    Permalink

  2. new OperatorMetadata(name: String, category: String, author: Option[String], version: Int, helpURL: Option[String], icon: Option[OperatorIcon], toolTipText: Option[String])

    Permalink

  3. new OperatorMetadata(name: String, category: String, author: String, version: Int, helpURL: String, icon: OperatorIcon, toolTipText: String, usesJavascript: Boolean)

    Permalink

  4. new OperatorMetadata(name: String, category: String, author: String, version: Int, helpURL: String, icon: OperatorIcon, toolTipText: String)

    Permalink

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

    Permalink

  6. new OperatorMetadata(name: String, category: String, author: Option[String], version: Int, helpURL: Option[String], icon: Option[OperatorIcon], toolTipText: Option[String], usesJavascript: Boolean)

    Permalink

    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

    icon

    Name and shape of the custom icon. To use the default icon, use Option.empty().

    toolTipText

    The text of the tool tip which appears when the user hovers over the icon for the operator in the left hand "operators" dropdown.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. val author: Option[String]

    Permalink

    the writer of the operator

  6. val category: String

    Permalink

    the category of operator i.e.

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

  7. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  9. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. val helpURL: Option[String]

    Permalink

    A link to documentation about the operator

  12. val icon: Option[OperatorIcon]

    Permalink

    Name and shape of the custom icon.

    Name and shape of the custom icon. To use the default icon, use Option.empty().

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. val name: String

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. val resolvedToolTip: String

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  20. val toolTipText: Option[String]

    Permalink

    The text of the tool tip which appears when the user hovers over the icon for the operator in the left hand "operators" dropdown.

  21. val usesJavascript: Boolean

    Permalink

  22. val version: Int

    Permalink

    the version number of this operator.

  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped