|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.unihalle.informatik.Alida.operator.ALDParameterDescriptor
de.unihalle.informatik.Alida.operator.ALDOpParameterDescriptor
public class ALDOpParameterDescriptor
This class describes the parameters of an operator.
A ALDOpParameterDescriptor
has a direction (IN, OUT, INOUT) and
a boolean indicating if this parameter is supplemental.
Field Summary | |
---|---|
protected Parameter.Direction |
direction
|
protected Boolean |
supplemental
|
Fields inherited from class de.unihalle.informatik.Alida.operator.ALDParameterDescriptor |
---|
dataIOOrder, defaultValue, explanation, field, handlingMode, label, myclass, name, required |
Constructor Summary | |
---|---|
ALDOpParameterDescriptor(String name,
Parameter.Direction direction,
Boolean supplemental,
Class<?> cl,
String explanation,
String label,
boolean required,
Object defaultValue,
Field field,
int guiOrder,
Parameter.ExpertMode mode)
Construct a descriptor |
Method Summary | |
---|---|
ALDOpParameterDescriptor |
clone()
Clone an instance |
ALDOpParameterDescriptor |
copy(Field field)
|
Parameter.Direction |
getDirection()
Returns parameter direction. |
Boolean |
getSupplemental()
Returns if parameter is supplemental. |
void |
print(PrintStream outfile)
Print this descriptor to outfile |
void |
print(PrintStream outfile,
ALDOperator op)
Print this descriptor to outfile. |
Methods inherited from class de.unihalle.informatik.Alida.operator.ALDParameterDescriptor |
---|
getDataIOOrder, getDefaultValue, getExplanation, getField, getHandlingMode, getLabel, getMyclass, getName, isRequired, print, setDefaultValue |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final Parameter.Direction direction
protected final Boolean supplemental
Constructor Detail |
---|
public ALDOpParameterDescriptor(String name, Parameter.Direction direction, Boolean supplemental, Class<?> cl, String explanation, String label, boolean required, Object defaultValue, Field field, int guiOrder, Parameter.ExpertMode mode)
name
- Name of parameter.direction
- Direction of parameter: IN/OUT/INOUT.supplemental
- Supplemental parameter flag.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.guiOrder
- Position in GUI of this member.mode
- Mode for handling the parameter.Method Detail |
---|
public ALDOpParameterDescriptor copy(Field field)
public ALDOpParameterDescriptor clone()
clone
in class ALDParameterDescriptor
public void print(PrintStream outfile)
print
in class ALDParameterDescriptor
public void print(PrintStream outfile, ALDOperator op)
If op
is non null then try to get the value of the parameter and print it also.
public Parameter.Direction getDirection()
public Boolean getSupplemental()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |