at.mug.iqm.core.processing.loader

Class TankItemLoader

java.lang.Object

javax.swing.SwingWorker<Object,Object>

at.mug.iqm.api.processing.AbstractProcessingTask

at.mug.iqm.core.processing.loader.TankItemLoader

All Implemented Interfaces:

IProcessingTask, Runnable, Future<Object>, RunnableFuture<Object>

Direct Known Subclasses:

SynchronousTankItemLoader

public class TankItemLoader
extends AbstractProcessingTask

This loader is responsible for asynchronously assembling items a given List of IqmDataBoxes to the DefaultListModel in the TankPanel . This class is called by the Tank's methods, e.g. when the user double clicks on the JList items in order to show an item in the LookPanel or PlotPanel.

Changes

• 2012 10 20 MMR: new DataBox-Type "Plot"

Author:

Philipp Kainz, Michael Mayrhofer-R.

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
protected DataType	dataType The type of the IqmDataBox content.
protected List<IqmDataBox>	list The list to load.
private static org.apache.log4j.Logger	logger Logging variable.
protected int	replaceIndex The index to be replaced.
protected boolean	replaceItem A flag whether to replace an existing stack.

Fields inherited from class at.mug.iqm.api.processing.AbstractProcessingTask

childTask, duration, headless, operator, operatorGUI, parentTask, startTime, virtual, workPackage

Constructor Summary

Constructors

Constructor and Description
TankItemLoader(List<IqmDataBox> list, boolean replaceItem, int replaceIndex) The constructor.

Method Summary

Modifier and Type	Method and Description
protected List<IqmDataBox>	addNewItems(List<IqmDataBox> list, boolean isVirtual, File virtDir) This method adds 1...n new items to the JList.
protected List<IqmDataBox>	doInBackground() This method must be implemented by all subclasses.
protected void	done() This method is called after the doInBackground() method and must be implemented by all subclasses.
DataType	getDataType()
List<IqmDataBox>	getList()
void	setDataType(DataType dataType)
void	setList(List<IqmDataBox> list)
protected void	setTankAndManager(List<IqmDataBox> listNew) Set the Tank and Manager.

Methods inherited from class at.mug.iqm.api.processing.AbstractProcessingTask

getChildTask, getOperator, getOperatorGUI, getParentTask, getWorkPackage, isHeadless, isVirtual, process, setChildTask, setHeadless, setOperator, setOperatorGUI, setParentTask, setVirtual, setWorkPackage

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.log4j.Logger logger

Logging variable.

list

protected List<IqmDataBox> list

The list to load.

replaceItem

protected boolean replaceItem

A flag whether to replace an existing stack.

replaceIndex

protected int replaceIndex

The index to be replaced.

dataType

protected DataType dataType

The type of the IqmDataBox content. Default: DataType.UNSUPPORTED

Constructor Detail

TankItemLoader

public TankItemLoader(List<IqmDataBox> list,
                      boolean replaceItem,
                      int replaceIndex)

The constructor.

Parameters:

list -

Method Detail

doInBackground

protected List<IqmDataBox> doInBackground()
                                   throws Exception

Description copied from class: AbstractProcessingTask

This method must be implemented by all subclasses.

Specified by:

doInBackground in class AbstractProcessingTask

Returns:

the processed result, retrievable by get().

Throws:

Exception

done

protected void done()

Description copied from class: AbstractProcessingTask

This method is called after the doInBackground() method and must be implemented by all subclasses. It is called too, when the SwingWorker is cancelled.

Overrides:

done in class AbstractProcessingTask

setTankAndManager

protected void setTankAndManager(List<IqmDataBox> listNew)
                          throws Exception

Set the Tank and Manager.

Parameters:

listNew -

Throws:

Exception

addNewItems

protected List<IqmDataBox> addNewItems(List<IqmDataBox> list,
                                       boolean isVirtual,
                                       File virtDir)

This method adds 1...n new items to the JList. An item stack is stored as a List of IqmDataBoxes. All elements (Plot, File, Image, Custom) are stored in an IqmDataBox.

For instance, a single image is represented as a list of one IqmDataBox.

Parameters:

list -

Returns:

a List of IqmDataBoxes

getList

public List<IqmDataBox> getList()

Returns:

the list

setList

public void setList(List<IqmDataBox> list)

Parameters:

list - the list to set

getDataType

public DataType getDataType()

Returns:

the dataType

setDataType

public void setDataType(DataType dataType)

Parameters:

dataType - the dataType to set