Package ai.libs.jaicore.graphvisualizer.window

Class AlgorithmVisualizationWindow

java.lang.Object

ai.libs.jaicore.graphvisualizer.window.AlgorithmVisualizationWindow

All Implemented Interfaces:

java.lang.Runnable

public class AlgorithmVisualizationWindow
extends java.lang.Object
implements java.lang.Runnable

An AlgorithmVisualizationWindow can be created to have a visualization of the behavior of an algorithm. We generally differentiate between a live version of an IAlgorithm run for which an instance of that algorithm and a list of AlgorithmEventPropertyComputers is required and an offline run, for which only an AlgorithmEventHistory is required. In the first case, the property computers are used to extract relevant information which is required by the IGUIPlugins (to be displayed) from the underlying IAlgorithmEvents which are provided by the actual algorithm. When playing a recording, these computers are not required as the data was already computed as is stored as part of the replay in the AlgorithmEventHistory. Furthermore it requires a main IGUIPlugin which will be displayed as the main element and optionally an unbounded amount of additional IGUIPlugin which will be displayed in order to provide additional information.

Constructor Summary

Constructors

Constructor	Description
AlgorithmVisualizationWindow(AlgorithmEventHistory history)
AlgorithmVisualizationWindow(AlgorithmEventHistory algorithmEventHistory, IGUIPlugin mainPlugin, IGUIPlugin... visualizationPlugins)	Creates a new AlgorithmVisualizationWindow based on the given AlgorithmEventHistory (i.e. offline version), the main IGUIPlugin and optionally additional plugins.
AlgorithmVisualizationWindow(org.api4.java.algorithm.IAlgorithm<?,?> algorithm)	Creates a new AlgorithmVisualizationWindow based on the given IAlgorithm, the list of AlgorithmEventPropertyComputers, a main IGUIPlugin and optionally additional plugins.

Method Summary

Modifier and Type	Method	Description
AlgorithmEventHistory	getAlgorithmEventHistory()	Returns the underlying AlgorithmEventHistory.
void	run()
void	setTitle(java.lang.String title)	Sets the title of this window to the given String.
AlgorithmVisualizationWindow	withMainPlugin(IGUIPlugin plugin)
AlgorithmVisualizationWindow	withPlugin(IGUIPlugin... pluginArray)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmVisualizationWindow

public AlgorithmVisualizationWindow(AlgorithmEventHistory history)

AlgorithmVisualizationWindow

public AlgorithmVisualizationWindow(AlgorithmEventHistory algorithmEventHistory,
                                    IGUIPlugin mainPlugin,
                                    IGUIPlugin... visualizationPlugins)

Creates a new AlgorithmVisualizationWindow based on the given AlgorithmEventHistory (i.e. offline version), the main IGUIPlugin and optionally additional plugins.

Parameters:

algorithmEventHistory - The AlgorithmEventHistory providing data to be displayed.

mainPlugin - The main IGUIPlugin which will be displayed as the main information source.

visualizationPlugins - A list of additional IGUIPlugins displaying side information.

AlgorithmVisualizationWindow

public AlgorithmVisualizationWindow(org.api4.java.algorithm.IAlgorithm<?,?> algorithm)

Creates a new AlgorithmVisualizationWindow based on the given IAlgorithm, the list of AlgorithmEventPropertyComputers, a main IGUIPlugin and optionally additional plugins. This constructor should be used when using a visualization in an online run.

Parameters:

algorithm - The IAlgorithm yielding information to be displayed.

algorithmEventPropertyComputers - The AlgorithmEventPropertyComputers computing all information from the IAlgorithmEvents provided by the IAlgorithm which are required by the IGUIPlugins which are registered.

mainPlugin - The main IGUIPlugin which will be displayed as the main information source.

visualizationPlugins - A list of additional IGUIPlugins displaying side information.

Method Detail

withMainPlugin

public AlgorithmVisualizationWindow withMainPlugin(IGUIPlugin plugin)

withPlugin

public AlgorithmVisualizationWindow withPlugin(IGUIPlugin... pluginArray)

run

public void run()

Specified by:

run in interface java.lang.Runnable

setTitle

public void setTitle(java.lang.String title)

Sets the title of this window to the given String.

Parameters:

title - The new title of this window.

getAlgorithmEventHistory

public AlgorithmEventHistory getAlgorithmEventHistory()

Returns the underlying AlgorithmEventHistory.

Returns:

The underlying AlgorithmEventHistory.