de.unihalle.informatik.Alida.annotations
Annotation Type Parameter


@Retention(value=RUNTIME)
@Target(value=FIELD)
@Documented
public @interface Parameter

Annotation definition for operator parameters.

Author:
Johannes Schindelin, Grant Harris, Curtis Rueden, Stefan Posch

Optional Element Summary
 java.lang.String[] choices
          Defines the list of possible values (multiple choice text fields only).
 int columns
          Defines the width of the input field in characters (text field parameters only).
 int dataIOOrder
          Suggest order if displaying all parameters of a parametrized class e.g. in a GUI
 java.lang.String description
          Gives a potentially verbose explanation of this field.
 Parameter.Direction direction
          Defines the direction of this parameter
 java.lang.String label
          Defines a label for the parameter.
 java.lang.String max
          Defines the maximum allowed value (numeric parameters only).
 java.lang.String min
          Defines the minimum allowed value (numeric parameters only).
 Parameter.ExpertMode mode
          Define the mode of this parameter to be shown for generic execution
 boolean output
          Defines if the parameter is an output.
 boolean persist
          Defines whether to remember the most recent value of the parameter.
 java.lang.String persistKey
          Defines a key to use for saving the value persistently.
 boolean required
          Defines whether the parameter is required (i.e., no default).
 java.lang.String stepSize
          Defines the step size to use (numeric parameters only).
 boolean supplemental
          Is this parameter supplemental, i.e. does not influence the result of the operator.
 Parameter.Type type
          Defines the type/role of this field.
 

choices

public abstract java.lang.String[] choices
Defines the list of possible values (multiple choice text fields only).

Default:
{}

columns

public abstract int columns
Defines the width of the input field in characters (text field parameters only).

Default:
6

dataIOOrder

public abstract int dataIOOrder
Suggest order if displaying all parameters of a parametrized class e.g. in a GUI

Default:
0

description

public abstract java.lang.String description
Gives a potentially verbose explanation of this field.

Default:
""

direction

public abstract Parameter.Direction direction
Defines the direction of this parameter

Default:
de.unihalle.informatik.Alida.annotations.Parameter.Direction.UNKNOWN

label

public abstract java.lang.String label
Defines a label for the parameter.

Default:
""

max

public abstract java.lang.String max
Defines the maximum allowed value (numeric parameters only).

Default:
""

min

public abstract java.lang.String min
Defines the minimum allowed value (numeric parameters only).

Default:
""

mode

public abstract Parameter.ExpertMode mode
Define the mode of this parameter to be shown for generic execution

Default:
de.unihalle.informatik.Alida.annotations.Parameter.ExpertMode.STANDARD

output

public abstract boolean output
Defines if the parameter is an output.

Default:
false

persist

public abstract boolean persist
Defines whether to remember the most recent value of the parameter.

Default:
true

persistKey

public abstract java.lang.String persistKey
Defines a key to use for saving the value persistently.

Default:
""

required

public abstract boolean required
Defines whether the parameter is required (i.e., no default).

Default:
false

stepSize

public abstract java.lang.String stepSize
Defines the step size to use (numeric parameters only).

Default:
""

supplemental

public abstract boolean supplemental
Is this parameter supplemental, i.e. does not influence the result of the operator. If true, the parameter is not documented in the processing history

Default:
false

type

public abstract Parameter.Type type
Defines the type/role of this field.

Default:
de.unihalle.informatik.Alida.annotations.Parameter.Type.PARAMETER