OperatorMetadata

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

Instance Constructors

new OperatorMetadata(name: String, category: String, version: Int = 1)
new OperatorMetadata(name: String, category: String, author: String, version: Int, helpURL: String, icon: OperatorIcon, toolTipText: String)
new OperatorMetadata(name: String, category: String, author: String, version: Int, helpURL: String, iconNamePrefix: String)
new OperatorMetadata(name: String, category: String, author: Option[String], version: Int, helpURL: Option[String], icon: Option[OperatorIcon], toolTipText: Option[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
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

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val author: Option[String]

the writer of the operator
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.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val helpURL: Option[String]

A link to documentation about the operator
val icon: Option[OperatorIcon]

Name and shape of the custom icon.
Name and shape of the custom icon. To use the default icon, use Option.empty().
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val name: String

the name of the operator as it shows up in the GUI
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val resolvedToolTip: String
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val toolTipText: Option[String]

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

the version number of this operator.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

case class OperatorMetadata(name: String, category: String, author: Option[String], version: Int, helpURL: Option[String], icon: Option[OperatorIcon], toolTipText: Option[String]) extends Product with Serializable

Instance Constructors

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

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

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

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

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val author: Option[String]

val category: String

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val helpURL: Option[String]

val icon: Option[OperatorIcon]

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val resolvedToolTip: String

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

val toolTipText: Option[String]

val version: Int

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped