@ALDParametrizedClass public class ALDParameterDescriptor extends Object implements Cloneable
The descriptions contains a name, the java class (mylass
, and an
explanatory string. The label
may be used, e.g. in a GUI, to
identify the parameter instead of using it name
. The
required
flag may not be interpreted for all parameters.
The field guiOrder
may be use to order of appearance of
parameters in user interfaces, where smaller order indicates early
appearance. Likewise handlingMode
may be used to influence GUIs.
Note: default values are valid only for the (very old) implementation without annotations an will disappear in the near future.
The field is used for internal means.
Implementational note: a reference to the Parameter-annotation is NOT included to allow for wrapping of non-Alida operators as Alida operators.
ALDOperator
Modifier and Type | Field and Description |
---|---|
protected String |
callback
Associated callback method.
|
protected int |
dataIOOrder
Data I/O order in GUI.
|
protected String |
explanation
Explanatory string.
|
protected Field |
field
Field corresponding to parameter.
|
protected Parameter.ExpertMode |
handlingMode
Parameter mode, i.e. if to be relevant for all users or experts only.
|
protected boolean |
info
Flag to indicate if it is just an info parameter.
|
protected String |
label
Label of the parameter.
|
protected Parameter.ParameterModificationMode |
modifyParamMode
Operator interface modification mode.
|
protected Class<?> |
myclass
Class of the parameter.
|
protected String |
name
Name of the parameter, i.e. its variable.
|
protected boolean |
required
Flag to indicate if parameter is required.
|
Modifier | Constructor and Description |
---|---|
protected |
ALDParameterDescriptor() |
|
ALDParameterDescriptor(String _name,
Class<?> cl,
String _explanation,
String _label,
boolean _required,
Field _field,
int guiOrder,
Parameter.ExpertMode mode,
String _callback,
Parameter.ParameterModificationMode modifyMode,
boolean _info)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
ALDParameterDescriptor |
clone()
Clones an instance.
|
String |
getCallback() |
int |
getDataIOOrder()
Returns data I/O order of parameter.
|
String |
getExplanation()
Returns explanation for parameter.
|
Field |
getField()
Returns a reference to the field of the parameter.
|
Parameter.ExpertMode |
getHandlingMode()
Returns mode of parameter handling.
|
String |
getLabel()
Returns label for parameter.
|
Class<?> |
getMyclass()
Returns class of parameter.
|
String |
getName()
Returns name of parameter.
|
boolean |
isInfo() |
boolean |
isRequired()
Returns is parameter is required.
|
Parameter.ParameterModificationMode |
parameterModificationMode() |
void |
print()
Print this descriptor to standard out.
|
void |
print(PrintStream outfile)
Print this descriptor to outfile.
|
@ALDClassParameter(label="name") protected final String name
@ALDClassParameter(label="myclass") protected final Class<?> myclass
@ALDClassParameter(label="explanation") protected final String explanation
@ALDClassParameter(label="label") protected final String label
protected final Field field
@ALDClassParameter(label="required") protected final boolean required
@ALDClassParameter(label="dataIOOrder") protected final int dataIOOrder
@ALDClassParameter(label="handlingMode") protected final Parameter.ExpertMode handlingMode
@ALDClassParameter(label="callback") protected final String callback
@ALDClassParameter(label="modifyParamMode") protected final Parameter.ParameterModificationMode modifyParamMode
@ALDClassParameter(label="info") protected final boolean info
protected ALDParameterDescriptor()
public ALDParameterDescriptor(String _name, Class<?> cl, String _explanation, String _label, boolean _required, Field _field, int guiOrder, Parameter.ExpertMode mode, String _callback, Parameter.ParameterModificationMode modifyMode, boolean _info)
_name
- Name of parameter.cl
- Java class._explanation
- Explanatory string._label
- Label for parameter._required
- Is this argument required for the operator?_field
- The field for this member.guiOrder
- mode
- _callback
- modifiesParameterDefinitions
- _info
- public String getName()
public Class<?> getMyclass()
public String getExplanation()
public String getLabel()
public int getDataIOOrder()
public Parameter.ExpertMode getHandlingMode()
public boolean isRequired()
public Field getField()
public String getCallback()
public Parameter.ParameterModificationMode parameterModificationMode()
public boolean isInfo()
public ALDParameterDescriptor clone()
public void print()
public void print(PrintStream outfile)
Copyright © 2010–2021 Martin Luther University Halle-Wittenberg, Institute of Computer Science, Pattern Recognition and Bioinformatics. All rights reserved.