This document describes the steps to create a new user defined operator with ODL.

Name

First you need to choose a meaningful name for the new operator. Note, there is no other operator with the same name.

Example

operator ODLSelect {
	//...
}

Metadata

Next you can set metadata to configure the operator with static information.

Example

operator ODLSelect(outputMode = "INPUT", minInputPorts = 1, maxInputPorts = 1){
    //...
}

The following table shows the available metadata:

Metadata	Possible values
outputmode (important)	"INPUT" read element wil not be modified "MODIFIED_INPUT" (default) read element will be modified "NEW_ELEMENT" operator creates a new element
persistent	true operator will be automatically added to operator framework of Odysseus after each start false (default)
minInputPorts	Integer-Value Minimal number of ports that the operator needs
maxInputPorts	Integer-Value Maximum number of ports that the operator needs

Please look at the LogicalOperator-Interface of Odysseus for more available metadata (e.g. doc, url, category).