de.unihalle.informatik.Alida.dataio.provider.swing

Class ALDCollectionDataIOSwing

java.lang.Object

de.unihalle.informatik.Alida.dataio.provider.ALDDataIOSwingInitialGUIValueDefaultHandler

de.unihalle.informatik.Alida.dataio.provider.swing.ALDCollectionDataIOSwing

All Implemented Interfaces:

ALDDataIO, ALDDataIOSwing

@ALDDataIOProvider
public class ALDCollectionDataIOSwing
extends ALDDataIOSwingInitialGUIValueDefaultHandler

Class for generic loading/saving of collections from/to GUI in Alida.

Author:

moeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ALDCollectionDataIOSwing.CollectionConfigButton GUI element for configuring collections.
private class	ALDCollectionDataIOSwing.CollectionConfigWindow Collection configuration window.
private class	ALDCollectionDataIOSwing.CollectionShowButton GUI element for displaying collections.

Constructor Summary

Constructors

Constructor and Description
ALDCollectionDataIOSwing()

Method Summary

Modifier and Type	Method and Description
ALDSwingComponent	createGUIElement(Field field, Class<?> cl, Object obj, ALDParameterDescriptor descr) Generic reading of collections.
Collection<Class<?>>	providedClasses() Interface method to announce class for which IO is provided for.
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 descr) Interface method for displaying an object in the GUI.

Methods inherited from class de.unihalle.informatik.Alida.dataio.provider.ALDDataIOSwingInitialGUIValueDefaultHandler

getInitialGUIValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ALDCollectionDataIOSwing

public ALDCollectionDataIOSwing()

Method Detail

providedClasses

public Collection<Class<?>> providedClasses()

Interface method to announce class for which IO is provided for.

Returns:

Collection of classes provided.

createGUIElement

public ALDSwingComponent createGUIElement(Field field,
                                          Class<?> cl,
                                          Object obj,
                                          ALDParameterDescriptor descr)

Generic reading of collections.

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.

setValue

public void setValue(Field field,
                     Class<?> cl,
                     ALDSwingComponent guiElement,
                     Object value)
              throws ALDDataIOProviderException

Description copied from interface: ALDDataIOSwing

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

public Object readData(Field field,
                       Class<?> cl,
                       ALDSwingComponent guiElement)
                throws ALDDataIOProviderException

Description copied from interface: ALDDataIOSwing

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

public JComponent writeData(Object obj,
                            ALDParameterDescriptor descr)
                     throws ALDDataIOProviderException

Description copied from interface: ALDDataIOSwing

Interface method for displaying an object in the GUI.

Parameters:

obj - Object to be displayed or saved.

descr - Optional descriptor to hand over additional information.

Returns:

Component visualizing the object.

Throws:

ALDDataIOProviderException - Thrown in case of failure.