@Retention(value=RUNTIME) @Target(value=FIELD) @Documented public @interface Parameter
Modifier and Type | Optional Element and Description |
---|---|
String |
callback
Name of a call back function to be invoked if the value of the parameter changes
|
String[] |
choices
Deprecated.
|
int |
columns
Deprecated.
|
int |
dataIOOrder
Suggest order if displaying all parameters of a parametrized class e.g. in a GUI
|
String |
description
Gives a potentially verbose explanation of this field.
|
Parameter.Direction |
direction
Defines the direction of this parameter
|
boolean |
info
If true this parameter is a pseudo parameter not used for input/output of the
operator but rather acts as information to be displayed in the user interface.
|
String |
label
Defines a label for the parameter.
|
String |
max
Deprecated.
|
String |
min
Deprecated.
|
Parameter.ExpertMode |
mode
Define the mode of this parameter to be shown for generic execution
|
boolean |
output
Deprecated.
|
Parameter.ParameterModificationMode |
paramModificationMode
Indicates the modification mode for the parameter.
|
boolean |
persist
Deprecated.
|
String |
persistKey
Deprecated.
|
boolean |
required
Defines whether the parameter is required (i.e., no default).
|
String |
stepSize
Deprecated.
|
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.
|
@Deprecated public abstract boolean output
public abstract String label
public abstract boolean required
@Deprecated public abstract boolean persist
@Deprecated public abstract String persistKey
public abstract Parameter.Type type
public abstract Parameter.Direction direction
public abstract Parameter.ExpertMode mode
public abstract boolean supplemental
public abstract int dataIOOrder
public abstract String description
public abstract String callback
public abstract boolean info
public abstract Parameter.ParameterModificationMode paramModificationMode
Depending on the value of the parameter argument, changing the value of the parameter may either result in changes of the values of other parameters or in a modification (i.e., adding, removing) of other parameters of the operator. The third option indicates that changing the value of the parameter has no effect on other parameters.
@Deprecated public abstract String min
@Deprecated public abstract String max
@Deprecated public abstract String stepSize
@Deprecated public abstract int columns
@Deprecated public abstract String[] choices
Copyright © 2010–2021 Martin Luther University Halle-Wittenberg, Institute of Computer Science, Pattern Recognition and Bioinformatics. All rights reserved.