at.mug.iqm.core.workflow

Class Tank

java.lang.Object

at.mug.iqm.core.workflow.Tank

All Implemented Interfaces:

ITank

public final class Tank
extends Object
implements ITank

This class contains a single instance of TankPanel (if set) and implements static operations on it. If no panel is set, the panel stays null.

Changes

• 2010 06 added fits format support
• 2010 08 added dcm format support
• 2010 09 tif file opening performance increased
• 2010 09 added progress bar functionality for loading image sequences
• 2012 02 21 MAJOR PROJECT CHANGE: Iqm uses the new IqmDataBox class
• 2012 02 24 adapted to new "Iqm2" layout
• 2012 03 29 PK: introduced method getModel() from IqmTankPanel. This substitutes the static member access.
• 2012 04 14 PK: i18n

Since:

2009

Author:

Helmut Ahammer, Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
private int	currTankIndex The currently selected item (stack) in the tank.
private static org.apache.log4j.Logger	logger
private int	maxTankIndex The maximum number (index) for the tank.
private PropertyChangeSupport	pcs A PropertyChangeSupport for this workflow control instance.
private TankPanel	tankPanel The tank panel.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Tank() A private constructor for this singleton

Method Summary

Modifier and Type	Method and Description
void	addNewItem(IqmDataBox item) This method adds 1 new item to the JList.
void	addNewItems(List<IqmDataBox> itemList) This method adds 1...n new items to the JList.
void	addNewItemsSync(List<IqmDataBox> itemList) Add a list of IqmDataBoxes as a single item in the tank.
void	addNewItemSync(IqmDataBox item) This method adds 1 new item to the JList.
void	deleteAllTankItems() This method deletes the entire tank list.
void	deleteTankItems(int[] indices) This method deletes a range of indices in the tank.
void	destroyItems() This method destroys existing tank items using the FIFO principle (queuing).
IqmDataBox	getCurrentTankIqmDataBoxAt(int mgrIndex) This method gets the IqmDataBox at the index mgrIndex of the currently selected tank list cell.
int	getCurrIndex() This method gets the current tank item number.
static ITank	getInstance() Gets the tank instance within this application.
int	getMaxIndex() This method gets the maximal tank item index.
int	getNumberOfTankItems() This method gets the number of List items
IqmDataBox	getSelectedIqmDataBox() This method gets the IqmDataBox, which according to the selected index in the current manager list, at the index of the currently selected tank list cell.
List<IqmDataBox>	getTankDataAt(int index) Gets the entire item stack at a specified index in the tank list.
IqmDataBox	getTankIqmDataBoxAt(int tankIndex, int mgrIndex) This method gets the IqmDataBox with the imgIndex at the index tankIndex (which is a cell) of the tank model.
TankPanel	getTankPanel() This method gets the tank panel instance.
boolean	isEmpty() Determine whether or not the Tank contains items.
boolean	isVirtual(int index) Determine whether a stack at position index is virtual or not.
void	loadImagesFromHD(File[] fileList) This method adds new single items (also stacks) to the JList in the tank panel.
void	loadImagesFromHD(File[] fileList, boolean waitForCompletion) This method adds new single items (also stacks) to the JList in the tank panel.
void	loadImagesFromHD(List<File> fileList) This method adds new single items (also stacks) to the JList in the tank panel.
void	loadNewImagesFromHDSequentially(List<File[]> batch) This method adds a batch of items (also stacks) sequentially to the JList in the tank panel.
DataType	parseDraggedContent(List<File> fileList) Checks for the DataType in a file dragged over the ITankPanel associated with this ITank instance.
void	runPlotParser(File f) Kicks off a PlotParser instance parsing the file and showing a PlotSelectionFrame for choosing data.
void	setCurrIndex(int arg) This method sets the current tank item number.
void	setManagerForTankIndex(int tankIndex) Tell the Manager to (re)set for a new tank index.
void	setMaxIndex(int arg) This method sets the maximal tank image number
void	setTankPanel(ITankPanel tankPanel) This method sets the tank panel instance in this class.
void	update(int tankIndex) Updates the specified tank items.
void	update(List<IqmDataBox> replacements, int tankIndex) Replaces the specified tank items.

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

tankPanel

private TankPanel tankPanel

The tank panel.

currTankIndex

private int currTankIndex

The currently selected item (stack) in the tank. Default is -1.

maxTankIndex

private int maxTankIndex

The maximum number (index) for the tank. Default is 0.

pcs

private PropertyChangeSupport pcs

A PropertyChangeSupport for this workflow control instance.

Constructor Detail

Tank

private Tank()

A private constructor for this singleton

Method Detail

getInstance

public static ITank getInstance()

Gets the tank instance within this application.

Returns:

the tank associated with this application

getTankPanel

public TankPanel getTankPanel()

This method gets the tank panel instance.

Specified by:

getTankPanel in interface ITank

Returns:

the tank panel, currently held by the class

setTankPanel

public void setTankPanel(ITankPanel tankPanel)

This method sets the tank panel instance in this class.

Specified by:

setTankPanel in interface ITank

Parameters:

tankPanel -

setCurrIndex

public void setCurrIndex(int arg)

This method sets the current tank item number.

It also highlights the corresponding cell of the JList.

Specified by:

setCurrIndex in interface ITank

Parameters:

arg - - current tank item number

getCurrIndex

public int getCurrIndex()

This method gets the current tank item number.

Specified by:

getCurrIndex in interface ITank

Returns:

current tank item number

setMaxIndex

public void setMaxIndex(int arg)

This method sets the maximal tank image number

Specified by:

setMaxIndex in interface ITank

Parameters:

arg - - maximal tank image number

getMaxIndex

public int getMaxIndex()

This method gets the maximal tank item index.

Specified by:

getMaxIndex in interface ITank

Returns:

maximal tank item index

setManagerForTankIndex

public void setManagerForTankIndex(int tankIndex)

Tell the Manager to (re)set for a new tank index.

Specified by:

setManagerForTankIndex in interface ITank

Parameters:

tankIndex - the tank index to generate the new icons from

See Also:

IManager.setNewIconsForTankIndex(int)

getTankDataAt

public List<IqmDataBox> getTankDataAt(int index)

Gets the entire item stack at a specified index in the tank list.

Specified by:

getTankDataAt in interface ITank

Parameters:

index - the tank list index

Returns:

a List

See Also:

ITankPanel.getModel()

destroyItems

public void destroyItems()

This method destroys existing tank items using the FIFO principle (queuing). First added items are destroyed first, if the number of tank items exceeds a determined value. The number of items to keep is set in the option-menu bar in TankPanel.

Specified by:

destroyItems in interface ITank

addNewItems

public void addNewItems(List<IqmDataBox> itemList)

This method adds 1...n new items to the JList.

This method should be used whenever new items are processed by the ResultVisualizer or new items or item stacks are loaded from any of the "Open" dialogs.

Specified by:

addNewItems in interface ITank

Parameters:

itemList - a list of IqmDataBoxes containing displayable items. This could be of the following types: DataType.IMAGE , DataType.PLOT, DataType.TABLE, or DataType.CUSTOM

update

public void update(List<IqmDataBox> replacements,
                   int tankIndex)

Description copied from interface: ITank

Replaces the specified tank items.

Specified by:

update in interface ITank

Parameters:

replacements - the new items

tankIndex - the items to be replaced

update

public void update(int tankIndex)

Description copied from interface: ITank

Updates the specified tank items.

Specified by:

update in interface ITank

loadNewImagesFromHDSequentially

public void loadNewImagesFromHDSequentially(List<File[]> batch)

This method adds a batch of items (also stacks) sequentially to the JList in the tank panel.

This is used, when the order of items or item stacks is important.

Specified by:

loadNewImagesFromHDSequentially in interface ITank

Parameters:

batch - List of File[]

loadImagesFromHD

public void loadImagesFromHD(File[] fileList)

This method adds new single items (also stacks) to the JList in the tank panel. The file list is loaded by a ImageDataBoxLoader instance in the background, displaying progress to the status panel.

This method is called by the OpenImageDialog.

Specified by:

loadImagesFromHD in interface ITank

Parameters:

fileList - a File[] containing new items for the tank list

loadImagesFromHD

public void loadImagesFromHD(File[] fileList,
                             boolean waitForCompletion)

This method adds new single items (also stacks) to the JList in the tank panel. The file list is loaded by a ImageDataBoxLoader instance in the background, displaying progress to the status panel.

This method is called by the OpenImageDialog.

Specified by:

loadImagesFromHD in interface ITank

Parameters:

fileList - a File[] containing new items for the tank list

waitForCompletion - waits for the loading to be finished

loadImagesFromHD

public void loadImagesFromHD(List<File> fileList)

This method adds new single items (also stacks) to the JList in the tank panel. The file list is loaded by a ImageDataBoxLoader instance in the background, displaying progress to the status panel.

This method is called by dragging images from the file system to the ITankPanel.

Specified by:

loadImagesFromHD in interface ITank

Parameters:

fileList - a List of Files containing new items for the tank list

getCurrentTankIqmDataBoxAt

public IqmDataBox getCurrentTankIqmDataBoxAt(int mgrIndex)

This method gets the IqmDataBox at the index mgrIndex of the currently selected tank list cell.

Specified by:

getCurrentTankIqmDataBoxAt in interface ITank

Parameters:

mgrIndex - - manager index

Returns:

the data box, or null, if the tank index is not valid (i.e. <0)

getTankIqmDataBoxAt

public IqmDataBox getTankIqmDataBoxAt(int tankIndex,
                                      int mgrIndex)

This method gets the IqmDataBox with the imgIndex at the index tankIndex (which is a cell) of the tank model.

Specified by:

getTankIqmDataBoxAt in interface ITank

Parameters:

tankIndex - - tank index

mgrIndex - - manager index

Returns:

the data box of the requested item, or null, if the tank index is not valid (i.e. <0)

getSelectedIqmDataBox

public IqmDataBox getSelectedIqmDataBox()

This method gets the IqmDataBox, which according to the selected index in the current manager list, at the index of the currently selected tank list cell.

Specified by:

getSelectedIqmDataBox in interface ITank

Returns:

the data box, or null, if the tank index is not valid (i.e. <0)

See Also:

ITank.getTankDataAt(int)

getNumberOfTankItems

public int getNumberOfTankItems()

This method gets the number of List items

Specified by:

getNumberOfTankItems in interface ITank

Returns:

the number of list items

deleteAllTankItems

public void deleteAllTankItems()

This method deletes the entire tank list.

Specified by:

deleteAllTankItems in interface ITank

deleteTankItems

public void deleteTankItems(int[] indices)

This method deletes a range of indices in the tank.

Specified by:

deleteTankItems in interface ITank

Parameters:

indices - the indices to be deleted

isEmpty

public boolean isEmpty()

Description copied from interface: ITank

Determine whether or not the Tank contains items.

Specified by:

isEmpty in interface ITank

Returns:

true if it is empty, false otherwise

isVirtual

public boolean isVirtual(int index)

Description copied from interface: ITank

Determine whether a stack at position index is virtual or not.

Specified by:

isVirtual in interface ITank

Returns:

true, if virtual, false otherwise

addNewItem

public void addNewItem(IqmDataBox item)

Description copied from interface: ITank

This method adds 1 new item to the JList. This is an asynchronous method, which will do the loading in background.

Specified by:

addNewItem in interface ITank

Parameters:

item - an IqmDataBox containing a single displayable item. This could be of the following types: DataType.IMAGE , DataType.PLOT, DataType.TABLE, or DataType.CUSTOM

parseDraggedContent

public DataType parseDraggedContent(List<File> fileList)

Description copied from interface: ITank

Checks for the DataType in a file dragged over the ITankPanel associated with this ITank instance.

Specified by:

parseDraggedContent in interface ITank

Parameters:

fileList - the List of files

Returns:

a DataType

runPlotParser

public void runPlotParser(File f)

Kicks off a PlotParser instance parsing the file and showing a PlotSelectionFrame for choosing data.

Specified by:

runPlotParser in interface ITank

Parameters:

f - the File to be parsed

addNewItemsSync

public void addNewItemsSync(List<IqmDataBox> itemList)

Description copied from interface: ITank

Add a list of IqmDataBoxes as a single item in the tank. This is a synchronous method that is waiting until loading has finished.

Specified by:

addNewItemsSync in interface ITank

addNewItemSync

public void addNewItemSync(IqmDataBox item)

Description copied from interface: ITank

This method adds 1 new item to the JList. This is a synchronous method that is waiting until loading has finished.

Specified by:

addNewItemSync in interface ITank

Parameters:

item - an IqmDataBox containing a single displayable item. This could be of the following types: DataType.IMAGE , DataType.PLOT, DataType.TABLE, or DataType.CUSTOM

See Also:

ITank.addNewItem(IqmDataBox)