de.unihalle.informatik.Alida.dataio.provider
Interface ALDDataIOSwing

All Superinterfaces:
ALDDataIO
All Known Implementing Classes:
ALDCollectionDataIOSwing, ALDEnumDataIOSwing, ALDFileDirectoryDataIOSwing, ALDNativeArray1DDataIOSwing, ALDNativeArray2DDataIOSwing, ALDNativeDataIOSwing, ALDOperatorDataIOSwing, ALDParametrizedClassDataIOSwing

public interface ALDDataIOSwing
extends ALDDataIO

Interface for Alida's automatic data I/O via GUIs based on Swing.

Author:
posch

Method Summary
 ALDSwingComponent createGUIElement(java.lang.reflect.Field field, java.lang.Class<?> cl, java.lang.Object obj, ALDParameterDescriptor descr)
          Interface method to create a GUI element for data input.
 java.lang.Object readData(java.lang.reflect.Field field, java.lang.Class<?> cl, ALDSwingComponent guiElement)
          Interface method for getting parameter values via a GUI element.
 void setValue(java.lang.reflect.Field field, java.lang.Class<?> cl, ALDSwingComponent guiElement, java.lang.Object value)
          Interface method for setting new parameter values in GUI.
 javax.swing.JComponent writeData(java.lang.Object obj, ALDParameterDescriptor d)
          Interface method for displaying an object in the GUI.
 
Methods inherited from interface de.unihalle.informatik.Alida.dataio.provider.ALDDataIO
providedClasses
 

Method Detail

createGUIElement

ALDSwingComponent createGUIElement(java.lang.reflect.Field field,
                                   java.lang.Class<?> cl,
                                   java.lang.Object obj,
                                   ALDParameterDescriptor descr)
                                   throws ALDDataIOProviderException
Interface method to create a GUI element for data input.

Optionally an object may be supplied which is assumed to be of type cl and used as default.

Parameters:
cl - Class of object to be returned.
obj - The value of this object to be set as inital value.
descr - Optional descriptor to hand over additional information.
Returns:
Alida GUI component to input values.
Throws:
ALDDataIOProviderException

readData

java.lang.Object readData(java.lang.reflect.Field field,
                          java.lang.Class<?> cl,
                          ALDSwingComponent guiElement)
                          throws ALDDataIOProviderException
Interface method for getting parameter values via a GUI element.

Parameters:
field - Field associated with object to be returned.
cl - Class of object to be returned.
guiElement - Component from where to read data.
Returns:
Object read from source, might be null.
Throws:
ALDDataIOProviderException

setValue

void setValue(java.lang.reflect.Field field,
              java.lang.Class<?> cl,
              ALDSwingComponent guiElement,
              java.lang.Object value)
              throws ALDDataIOProviderException
Interface method for setting new parameter values in GUI.

Parameters:
field - Field of parameter object to be handled.
cl - Class of parameter object to be handled.
guiElement - Corresponding GUI element.
value - New value of the parameter.
Throws:
ALDDataIOProviderException

writeData

javax.swing.JComponent writeData(java.lang.Object obj,
                                 ALDParameterDescriptor d)
                                 throws ALDDataIOProviderException
Interface method for displaying an object in the GUI.

Parameters:
obj - Object to be displayed or saved.
d - Optional descriptor to hand over additional information.
Throws:
ALDDataIOProviderException