|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.unihalle.informatik.Alida.operator.ALDParameterDescriptor
public class ALDParameterDescriptor
This class describes generic parameters in Alida used, e.g., in paramterized classes and operators.
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 disapear in th enear 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
Field Summary | |
---|---|
protected int |
dataIOOrder
|
protected java.lang.Object |
defaultValue
|
protected java.lang.String |
explanation
|
protected java.lang.reflect.Field |
field
|
protected Parameter.ExpertMode |
handlingMode
|
protected java.lang.String |
label
|
protected java.lang.Class<?> |
myclass
|
protected java.lang.String |
name
|
protected boolean |
required
|
Constructor Summary | |
---|---|
ALDParameterDescriptor(java.lang.String name,
java.lang.Class<?> cl,
java.lang.String explanation,
java.lang.String label,
boolean required,
java.lang.Object defaultValue,
java.lang.reflect.Field field,
int guiOrder,
Parameter.ExpertMode mode)
Constructor. |
Method Summary | |
---|---|
ALDParameterDescriptor |
clone()
Clones an instance. |
int |
getDataIOOrder()
Returns data I/O order of parameter. |
java.lang.Object |
getDefaultValue()
Returns default value of parameter. |
java.lang.String |
getExplanation()
Returns explanation for parameter. |
java.lang.reflect.Field |
getField()
Returns a reference to the field of the parameter. |
Parameter.ExpertMode |
getHandlingMode()
Returns mode of parameter handling. |
java.lang.String |
getLabel()
Returns label for parameter. |
java.lang.Class<?> |
getMyclass()
Returns class of parameter. |
java.lang.String |
getName()
Returns name of parameter. |
boolean |
isRequired()
Returns is parameter is required. |
void |
print()
Print this descriptor to standard out. |
void |
print(java.io.PrintStream outfile)
Print this descriptor to outfile. |
void |
setDefaultValue(java.lang.Object def)
Specify default value of parameter. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final java.lang.String name
protected final java.lang.Class<?> myclass
protected final java.lang.String explanation
protected final java.lang.String label
protected java.lang.Object defaultValue
protected final java.lang.reflect.Field field
protected final boolean required
protected final int dataIOOrder
protected final Parameter.ExpertMode handlingMode
Constructor Detail |
---|
public ALDParameterDescriptor(java.lang.String name, java.lang.Class<?> cl, java.lang.String explanation, java.lang.String label, boolean required, java.lang.Object defaultValue, java.lang.reflect.Field field, int guiOrder, Parameter.ExpertMode mode)
name
- Name of parameter.cl
- Java class.explanation
- Explanatory string.label
- Label for parameter.required
- Is this argument required for the operator?defaultValue
- Default value.field
- The field for this member.Method Detail |
---|
public java.lang.String getName()
public java.lang.Class<?> getMyclass()
public java.lang.String getExplanation()
public java.lang.String getLabel()
public int getDataIOOrder()
public Parameter.ExpertMode getHandlingMode()
public boolean isRequired()
public java.lang.Object getDefaultValue()
public void setDefaultValue(java.lang.Object def)
public java.lang.reflect.Field getField()
public ALDParameterDescriptor clone()
clone
in class java.lang.Object
public void print()
public void print(java.io.PrintStream outfile)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |