de.unihalle.informatik.Alida.operator
Class ALDParameterDescriptor

java.lang.Object
  extended by de.unihalle.informatik.Alida.operator.ALDParameterDescriptor
Direct Known Subclasses:
ALDOpParameterDescriptor

public class ALDParameterDescriptor
extends java.lang.Object

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.

Author:
moeller
See Also:
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

dataIOOrder

protected final int dataIOOrder

defaultValue

protected java.lang.Object defaultValue

explanation

protected final java.lang.String explanation

field

protected final java.lang.reflect.Field field

handlingMode

protected final Parameter.ExpertMode handlingMode

label

protected final java.lang.String label

myclass

protected final java.lang.Class<?> myclass

name

protected final java.lang.String name

required

protected final boolean required
Constructor Detail

ALDParameterDescriptor

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)
Constructor.

Parameters:
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

clone

public ALDParameterDescriptor clone()
Clones an instance.

Overrides:
clone in class java.lang.Object

getDataIOOrder

public int getDataIOOrder()
Returns data I/O order of parameter.


getDefaultValue

public java.lang.Object getDefaultValue()
Returns default value of parameter.


getExplanation

public java.lang.String getExplanation()
Returns explanation for parameter.


getField

public java.lang.reflect.Field getField()
Returns a reference to the field of the parameter.


getHandlingMode

public Parameter.ExpertMode getHandlingMode()
Returns mode of parameter handling.


getLabel

public java.lang.String getLabel()
Returns label for parameter.


getMyclass

public java.lang.Class<?> getMyclass()
Returns class of parameter.


getName

public java.lang.String getName()
Returns name of parameter.


isRequired

public boolean isRequired()
Returns is parameter is required.


print

public void print()
Print this descriptor to standard out.


print

public void print(java.io.PrintStream outfile)
Print this descriptor to outfile.


setDefaultValue

public void setDefaultValue(java.lang.Object def)
Specify default value of parameter.