IResult (IQM 3.5 API)

All Known Implementing Classes:

Result
```
public interface IResult
```
The IResult is produced by the IOperator by processing of an IWorkPackage. Since the output of an IOperator can be heterogeneous (e.g. image AND plot AND table), the results are stored in a List. Each index position on the list corresponds to a unique data type (see IQM’s DataModel specification). For instance, if ten images are the output of an operator, the list contains an ArrayList of ten IqmDataBoxes at index 0.
The specified order of result elements in the list is:
- 0: images (0…n)
- 1: plots (0…n)
- 2: tables (0…n)
- 3: custom (0…n)
- >3: currently not used, but extensible for other types
Furthermore, the IResult declares methods for convenient access to and management of the single result elements.
Author:

Philipp Kainz

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addItem(IDataModel item)` Adds a `IDataModel` item to the `Result`.
`void`	`addItem(IqmDataBox item)` Adds an item to the `Result`.
`boolean`	`hasCustomResults()` Returns whether or not the result contains custom results.
`boolean`	`hasImages()` Returns whether or not the result contains images.
`boolean`	`hasPlots()` Returns whether or not the result contains plots.
`boolean`	`hasTables()` Returns whether or not the result contains tables.
`boolean`	`isMultiResult()` This function checks if the result holds more than one item.
`List<ArrayList<IqmDataBox>>`	`listAllElements()` Gets the registry of the results.
`ArrayList<IqmDataBox>`	`listCustomResults()` Gets all custom results as `IqmDataBox`es in this result object.
`ArrayList<IqmDataBox>`	`listImageResults()` Gets all image results as `IqmDataBox`es in this result object.
`ArrayList<IqmDataBox>`	`listPlotResults()` Gets all plot results as `IqmDataBox`es in this result object.
`ArrayList<IqmDataBox>`	`listTableResults()` Gets all table results as `IqmDataBox`es in this result object.

- Method Detail
  - listAllElements
```
List<ArrayList<IqmDataBox>> listAllElements()
```
    Gets the registry of the results.
    
    Returns:
    
    a List of ArrayLists containing image, plot, table and custom results
  - listImageResults
```
ArrayList<IqmDataBox> listImageResults()
```
    Gets all image results as IqmDataBoxes in this result object.
    
    Returns:
    
    the image results, or null if no images are set
  - listPlotResults
```
ArrayList<IqmDataBox> listPlotResults()
```
    Gets all plot results as IqmDataBoxes in this result object.
    
    Returns:
    
    the plot results, or null if no plots are set
  - listTableResults
```
ArrayList<IqmDataBox> listTableResults()
```
    Gets all table results as IqmDataBoxes in this result object.
    
    Returns:
    
    the table results, or null if no tables are set
  - listCustomResults
```
ArrayList<IqmDataBox> listCustomResults()
```
    Gets all custom results as IqmDataBoxes in this result object.
    
    Returns:
    
    the custom results, or null if no custom results are set
  - hasImages
```
boolean hasImages()
```
    Returns whether or not the result contains images.
    
    Returns:
    
    true, if images are present, false otherwise
  - hasPlots
```
boolean hasPlots()
```
    Returns whether or not the result contains plots.
    
    Returns:
    
    true, if plots are present, false otherwise
  - hasTables
```
boolean hasTables()
```
    Returns whether or not the result contains tables.
    
    Returns:
    
    true, if tables are present, false otherwise
  - hasCustomResults
```
boolean hasCustomResults()
```
    Returns whether or not the result contains custom results.
    
    Returns:
    
    true, if custom results are present, false otherwise
  - addItem
```
void addItem(IqmDataBox item)
      throws IllegalArgumentException
```
    Adds an item to the Result.
    The correct ArrayList of the item is determined by the data type of the IqmDataBox.
    
    Parameters:
    
    item -
    
    Throws:
    
    IllegalArgumentException - if the item is null
  - addItem
```
void addItem(IDataModel item)
      throws IllegalArgumentException
```
    Adds a IDataModel item to the Result.
    The correct ArrayList of the item is determined by the data type of the IqmDataBox.
    
    Parameters:
    
    item -
    
    Throws:
    
    IllegalArgumentException - if the item is null
  - isMultiResult
```
boolean isMultiResult()
```
    This function checks if the result holds more than one item.
    
    Returns:
    
    true, if the result contains more than one item, false otherwise

Interface IResult

Method Summary

Method Detail

listAllElements

listImageResults

listPlotResults

listTableResults

listCustomResults

hasImages

hasPlots

hasTables

hasCustomResults

addItem

addItem

isMultiResult