de.unihalle.informatik.Alida.dataio.provider

Interface ALDDataIOSwing

All Superinterfaces:

ALDDataIO

All Known Implementing Classes:

ALDCollectionDataIOSwing, ALDDataIOSwingInitialGUIValueDefaultHandler, ALDEnumDataIOSwing, ALDEnumSetDataIOSwing, ALDFileDirectoryDataIOSwing, ALDHashMapDataIOSwing, 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

Modifier and Type	Method and Description
ALDSwingComponent	createGUIElement(Field field, Class<?> cl, Object obj, ALDParameterDescriptor descr) Interface method to create a GUI element for data input.
Object	getInitialGUIValue(Field field, Class<?> cl, Object obj, ALDParameterDescriptor descr) Interface method to request initial GUI values of provider.
Object	readData(Field field, Class<?> cl, ALDSwingComponent guiElement) Interface method for getting parameter values via a GUI element.
void	setValue(Field field, Class<?> cl, ALDSwingComponent guiElement, Object value) Interface method for setting new parameter values in GUI.
JComponent	writeData(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

getInitialGUIValue

Object getInitialGUIValue(Field field,
                          Class<?> cl,
                          Object obj,
                          ALDParameterDescriptor descr)
                   throws ALDDataIOProviderException

Interface method to request initial GUI values of provider.

Note that while the object is allowed to be null the descriptor has to be different from null in any case.

Parameters:

field - Field of the parameter the GUI element is linked to.

cl - Class of the parameter and the returned object.

obj - The current value of corresponding parameter.

descr - Optional descriptor to provide additional information.

Returns:

Value that the provider will display in GUI.

Throws:

ALDDataIOProviderException - Thrown in case of failure.

createGUIElement

ALDSwingComponent createGUIElement(Field field,
                                   Class<?> cl,
                                   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:

field - Field of the parameter the GUI element is linked to.

cl - Class of object to be returned.

obj - The value of this object to be set as inital value.

descr - Optional descriptor to provide additional information.

Returns:

Alida GUI component to input values.

Throws:

ALDDataIOProviderException - Thrown in case of failure.

setValue

void setValue(Field field,
              Class<?> cl,
              ALDSwingComponent guiElement,
              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 - Thrown in case of failure.

readData

Object readData(Field field,
                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 - Thrown in case of failure.

writeData

JComponent writeData(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.

Returns:

Component visualizing the object.

Throws:

ALDDataIOProviderException - Thrown in case of failure.