at.mug.iqm.api.operator

Class Result

java.lang.Object

at.mug.iqm.api.operator.Result

All Implemented Interfaces:

IResult

public class Result
extends Object
implements IResult

The result is a ready-to-use implementation of IResult.

Author:

Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<IqmDataBox>	customResults
protected ArrayList<IqmDataBox>	imageResults
protected ArrayList<IqmDataBox>	plotResults
protected List<ArrayList<IqmDataBox>>	resultRegistry
protected ArrayList<IqmDataBox>	tableResults

Constructor Summary

Constructors

Constructor and Description
Result()
Result(IDataModel item) Creates a new Result and adds the item to the correct result list.
Result(IqmDataBox item) Creates a new Result and adds the item to the correct result list.

Method Summary

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.
static boolean	isMultiResult(IResult result) 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 IqmDataBoxes in this result object.
ArrayList<IqmDataBox>	listImageResults() Gets all image results as IqmDataBoxes in this result object.
ArrayList<IqmDataBox>	listPlotResults() Gets all plot results as IqmDataBoxes in this result object.
ArrayList<IqmDataBox>	listTableResults() Gets all table results as IqmDataBoxes in this result object.

Methods inherited from class java.lang.Object

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

Field Detail

resultRegistry

protected List<ArrayList<IqmDataBox>> resultRegistry

imageResults

protected ArrayList<IqmDataBox> imageResults

plotResults

protected ArrayList<IqmDataBox> plotResults

tableResults

protected ArrayList<IqmDataBox> tableResults

customResults

protected ArrayList<IqmDataBox> customResults

Constructor Detail

Result

public Result()

Result

public Result(IqmDataBox item)

Creates a new Result and adds the item to the correct result list.

Parameters:

item -

Result

public Result(IDataModel item)

Creates a new Result and adds the item to the correct result list.

Parameters:

item -

Method Detail

listAllElements

public List<ArrayList<IqmDataBox>> listAllElements()

Gets the registry of the results.

Specified by:

listAllElements in interface IResult

Returns:

a List of ArrayLists containing image, plot, table and custom results

listImageResults

public ArrayList<IqmDataBox> listImageResults()

Gets all image results as IqmDataBoxes in this result object.

Specified by:

listImageResults in interface IResult

Returns:

the image results, or null if no images are set

listPlotResults

public ArrayList<IqmDataBox> listPlotResults()

Gets all plot results as IqmDataBoxes in this result object.

Specified by:

listPlotResults in interface IResult

Returns:

the plot results, or null if no plots are set

listTableResults

public ArrayList<IqmDataBox> listTableResults()

Gets all table results as IqmDataBoxes in this result object.

Specified by:

listTableResults in interface IResult

Returns:

the table results

listCustomResults

public ArrayList<IqmDataBox> listCustomResults()

Gets all custom results as IqmDataBoxes in this result object.

Specified by:

listCustomResults in interface IResult

Returns:

the custom results

hasImages

public boolean hasImages()

Returns whether or not the result contains images.

Specified by:

hasImages in interface IResult

Returns:

true, if images are present, false otherwise

hasPlots

public boolean hasPlots()

Returns whether or not the result contains plots.

Specified by:

hasPlots in interface IResult

Returns:

true, if plots are present, false otherwise

hasTables

public boolean hasTables()

Returns whether or not the result contains tables.

Specified by:

hasTables in interface IResult

Returns:

true, if tables are present, false otherwise

hasCustomResults

public boolean hasCustomResults()

Returns whether or not the result contains custom results.

Specified by:

hasCustomResults in interface IResult

Returns:

true, if custom results are present, false otherwise

addItem

public void addItem(IqmDataBox item)
             throws IllegalArgumentException

Adds an item to the Result.

The correct ArrayList for the item is determined by the data type of the IqmDataBox.

Specified by:

addItem in interface IResult

Parameters:

item - the IqmDataBox

Throws:

IllegalArgumentException - if the item is null

addItem

public 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.

Specified by:

addItem in interface IResult

Parameters:

item -

Throws:

IllegalArgumentException - if the item is null

isMultiResult

public boolean isMultiResult()

Description copied from interface: IResult

This function checks if the result holds more than one item.

Specified by:

isMultiResult in interface IResult

Returns:

true, if the result contains more than one item, false otherwise

isMultiResult

public static boolean isMultiResult(IResult result)

This function checks if the result holds more than one item.

Parameters:

result - a IResult to be tested

Returns:

true, if the result contains more than one item, false otherwise