ITank (IQM 3.5 API)

All Known Implementing Classes:

Tank
```
public interface ITank
```
This interface defines methods for the the Tank, a major workflow control element.

Since:

3.0

Author:

Philipp Kainz

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addNewItem(IqmDataBox item)` This method adds 1 new item to the `JList`.
`void`	`addNewItems(List<IqmDataBox> itemList)` Add a list of `IqmDataBox`es as a single item in the tank.
`void`	`addNewItemsSync(List<IqmDataBox> itemList)` Add a list of `IqmDataBox`es as a single item in the tank.
`void`	`addNewItemSync(IqmDataBox item)` This method adds 1 new item to the `JList`.
`void`	`deleteAllTankItems()` Purges the tank.
`void`	`deleteTankItems(int[] indices)` Delete selected indices of the tank.
`void`	`destroyItems()` Destroys the items according to the current settings.
`IqmDataBox`	`getCurrentTankIqmDataBoxAt(int mgrIndex)` Fetches the `IqmDataBox` instance at the specified index of the currently selected Tank item.
`int`	`getCurrIndex()` Get the current index.
`int`	`getMaxIndex()`
`int`	`getNumberOfTankItems()` Get the number of total tank items.
`IqmDataBox`	`getSelectedIqmDataBox()` Fetches the current `IqmDataBox` according to the selected item in the manager.
`List<IqmDataBox>`	`getTankDataAt(int index)` Fetches all data boxes in a specified tank index.
`IqmDataBox`	`getTankIqmDataBoxAt(int tankIndex, int mgrIndex)` Fetches the `IqmDataBox` instance at a specified tank and a specified manager index.
`ITankPanel`	`getTankPanel()` Get the tank panel.
`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)` Loads items from files on the hard drive.
`void`	`loadImagesFromHD(File[] fileList, boolean waitForCompletion)` Loads items from files on the hard drive.
`void`	`loadImagesFromHD(List<File> fileList)` Loads items from files on the hard drive.
`void`	`loadNewImagesFromHDSequentially(List<File[]> batch)` Sequentially adds a `List` of `File`[] to the tank.
`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)` Runs the plot parser for a selected file.
`void`	`setCurrIndex(int arg)` Set the current index.
`void`	`setManagerForTankIndex(int tankIndex)` Set the manager for a tank index.
`void`	`setMaxIndex(int arg)`
`void`	`setTankPanel(ITankPanel tankPanel)` Set the tank panel.
`void`	`update(int tankIndex)` Updates the specified tank items.
`void`	`update(List<IqmDataBox> replacement, int tankIndex)` Replaces the specified tank items.

- Method Detail
  - deleteAllTankItems
```
void deleteAllTankItems()
```
    Purges the tank.
  - getNumberOfTankItems
```
int getNumberOfTankItems()
```
    Get the number of total tank items.
    
    Returns:
  - getTankIqmDataBoxAt
```
IqmDataBox getTankIqmDataBoxAt(int tankIndex,
                               int mgrIndex)
                        throws ArrayIndexOutOfBoundsException
```
    Fetches the IqmDataBox instance at a specified tank and a specified manager index.
    
    Parameters:
    
    tankIndex - a custom tank item
    
    mgrIndex - the selected item in the stack at tank position tankIndex
    
    Returns:
    
    the data box at the specified location, or null if no item is present
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if either one of the requested indices is out of bounds
  - getCurrentTankIqmDataBoxAt
```
IqmDataBox getCurrentTankIqmDataBoxAt(int mgrIndex)
                               throws ArrayIndexOutOfBoundsException
```
    Fetches the IqmDataBox instance at the specified index of the currently selected Tank item.
    
    Parameters:
    
    mgrIndex - the selected stack item at the current tank position
    
    Returns:
    
    the data box at the requested position, or null if no item is present
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the requested index is out of bounds
  - getSelectedIqmDataBox
```
IqmDataBox getSelectedIqmDataBox()
```
    Fetches the current IqmDataBox according to the selected item in the manager. Whether the right or left list represents and maintains the tank item is determined automatically.
    Note: This method is similar to getTankDataAt(int).
    
    Returns:
    
    the data box at the selected location or null, if no item is present
    
    See Also:
    
    getTankDataAt(int)
  - getTankDataAt
```
List<IqmDataBox> getTankDataAt(int index)
```
    Fetches all data boxes in a specified tank index.
    This method gets the data as List of IqmDataBoxes at the specified index.
    
    Parameters:
    
    index - the tank list position
    
    Returns:
    
    a List
  - loadImagesFromHD
```
void loadImagesFromHD(File[] fileList)
```
    Loads items from files on the hard drive.
    
    Parameters:
    
    fileList - an array of Files
  - loadImagesFromHD
```
void loadImagesFromHD(List<File> fileList)
```
    Loads items from files on the hard drive.
    
    Parameters:
    
    fileList - a List of Files
  - loadNewImagesFromHDSequentially
```
void loadNewImagesFromHDSequentially(List<File[]> batch)
```
    Sequentially adds a List of File[] to the tank.
    
    Parameters:
    
    batch -
  - addNewItems
```
void addNewItems(List<IqmDataBox> itemList)
```
    Add a list of IqmDataBoxes as a single item in the tank. This is an asynchronous method, which will do the loading in background.
    
    Parameters:
    
    itemList -
  - addNewItemsSync
```
void addNewItemsSync(List<IqmDataBox> itemList)
```
    Add a list of IqmDataBoxes as a single item in the tank. This is a synchronous method that is waiting until loading has finished.
    
    Parameters:
    
    itemList -
  - addNewItem
```
void addNewItem(IqmDataBox item)
```
    This method adds 1 new item to the JList. This is an asynchronous method, which will do the loading in background.
    
    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
  - addNewItemSync
```
void addNewItemSync(IqmDataBox item)
```
    This method adds 1 new item to the JList. This is a synchronous method that is waiting until loading has finished.
    
    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:
    
    addNewItem(IqmDataBox)
  - destroyItems
```
void destroyItems()
```
    Destroys the items according to the current settings.
  - setManagerForTankIndex
```
void setManagerForTankIndex(int tankIndex)
```
    Set the manager for a tank index. This loads the stack to the selected manager list and displays the first item in the corresponding tab.
    
    Parameters:
    
    tankIndex -
  - isEmpty
```
boolean isEmpty()
```
    Determine whether or not the Tank contains items.
    
    Returns:
    
    true if it is empty, false otherwise
  - getCurrIndex
```
int getCurrIndex()
```
    Get the current index.
    
    Returns:
  - setCurrIndex
```
void setCurrIndex(int arg)
```
    Set the current index.
    
    Parameters:
    
    arg -
  - setTankPanel
```
void setTankPanel(ITankPanel tankPanel)
```
    Set the tank panel.
    
    Parameters:
    
    tankPanel -
  - getTankPanel
```
ITankPanel getTankPanel()
```
    Get the tank panel.
    
    Returns:
  - getMaxIndex
```
int getMaxIndex()
```
  - setMaxIndex
```
void setMaxIndex(int arg)
```
  - isVirtual
```
boolean isVirtual(int index)
```
    Determine whether a stack at position index is virtual or not.
    
    Parameters:
    
    index -
    
    Returns:
    
    true, if virtual, false otherwise
  - parseDraggedContent
```
DataType parseDraggedContent(List<File> fileList)
                      throws MultipleMIMETypesException
```
    Checks for the DataType in a file dragged over the ITankPanel associated with this ITank instance.
    
    Parameters:
    
    fileList - the List of files
    
    Returns:
    
    a DataType
    
    Throws:
    
    MultipleMIMETypesException - if the list includes more than one MIME type
  - runPlotParser
```
void runPlotParser(File f)
```
    Runs the plot parser for a selected file.
    
    Parameters:
    
    f - a file containing signal data
  - deleteTankItems
```
void deleteTankItems(int[] indices)
```
    Delete selected indices of the tank.
    
    Parameters:
    
    indices - the indices to be deleted
  - update
```
void update(int tankIndex)
```
    Updates the specified tank items.
    
    Parameters:
    
    tankIndex -
  - update
```
void update(List<IqmDataBox> replacement,
            int tankIndex)
```
    Replaces the specified tank items.
    
    Parameters:
    
    replacement - the new items
    
    tankIndex - the items to be replaced
  - loadImagesFromHD
```
void loadImagesFromHD(File[] fileList,
                      boolean waitForCompletion)
```
    Loads items from files on the hard drive.
    
    Parameters:
    
    fileList - an array of Files
    
    waitForCompletion - a flag whether to block the caller until file loading completed

Interface ITank

Method Summary

Method Detail

deleteAllTankItems

getNumberOfTankItems

getTankIqmDataBoxAt

getCurrentTankIqmDataBoxAt

getSelectedIqmDataBox

getTankDataAt

loadImagesFromHD

loadImagesFromHD

loadNewImagesFromHDSequentially

addNewItems

addNewItemsSync

addNewItem

addNewItemSync

destroyItems

setManagerForTankIndex

isEmpty

getCurrIndex

setCurrIndex

setTankPanel

getTankPanel

getMaxIndex

setMaxIndex

isVirtual

parseDraggedContent

runPlotParser

deleteTankItems

update

update

loadImagesFromHD