org.intellimate.izou.output

Class OutputManager

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.output.OutputManager

All Implemented Interfaces:

Identifiable, AddonThreadPoolUser, MainProvider

public class OutputManager
extends IzouModule
implements AddonThreadPoolUser

OutputManager manages all output plugins and is the main class anyone outside the output package should talk to. It can register/remove new output-plugins and add/delete output-extensions

Field Summary

Fields inherited from class org.intellimate.izou.util.IzouModule

log, main

Constructor Summary

Constructors

Constructor and Description
OutputManager(Main main) Creates a new output-manager with a list of output-plugins

Method Summary

Modifier and Type	Method and Description
void	addOutputExtension(OutputExtensionModel<?,?> outputExtension) adds output extension to desired outputPlugin
void	addOutputPlugin(OutputPluginModel<?,?> outputPlugin) adds outputPlugin to outputPluginList, starts a new thread for the outputPlugin, and stores the future object in a HashMap
<T,X> List<CompletableFuture<X>>	generateAllOutputExtensions(OutputPluginModel<T,X> outputPlugin, T t, EventModel event) starts every associated OutputExtension
List<Identification>	getAssociatedOutputExtension(OutputPluginModel<?,?> outputPlugin) returns all the associated OutputExtensions
void	passDataToOutputPlugins(EventModel event) gets the Event and sends it to the right outputPlugin for further processing
void	removeOutputExtension(OutputExtensionModel<?,?> outputExtension) removes the output-extension of id: extensionId from outputPluginList
void	removeOutputPlugin(OutputPluginModel outputPlugin) removes the OutputPlugin and stops the thread

Methods inherited from class org.intellimate.izou.util.IzouModule

debug, debug, error, error, fatal, fatal, getID, getMain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.util.AddonThreadPoolUser

submit, submit, timeOut

Methods inherited from interface org.intellimate.izou.util.MainProvider

debug, debug, error, error, fatal, fatal, getMain

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

OutputManager

public OutputManager(Main main)

Creates a new output-manager with a list of output-plugins

Parameters:

main - the main instance started from

Method Detail

addOutputPlugin

public void addOutputPlugin(OutputPluginModel<?,?> outputPlugin)
                     throws IllegalIDException

adds outputPlugin to outputPluginList, starts a new thread for the outputPlugin, and stores the future object in a HashMap

Parameters:

outputPlugin - OutputPlugin to add

Throws:

IllegalIDException - not yet implemented

removeOutputPlugin

public void removeOutputPlugin(OutputPluginModel outputPlugin)

removes the OutputPlugin and stops the thread

Parameters:

outputPlugin - the outputPlugin to remove

addOutputExtension

public void addOutputExtension(OutputExtensionModel<?,?> outputExtension)
                        throws IllegalIDException

adds output extension to desired outputPlugin

adds output extension to desired outputPlugin, so that the output-plugin can start and stop the outputExtension task as needed. The outputExtension is specific to the output-plugin

Parameters:

outputExtension - the outputExtension to be added

Throws:

IllegalIDException - not yet implemented

removeOutputExtension

public void removeOutputExtension(OutputExtensionModel<?,?> outputExtension)

removes the output-extension of id: extensionId from outputPluginList

Parameters:

outputExtension - the OutputExtension to remove

passDataToOutputPlugins

public void passDataToOutputPlugins(EventModel event)

gets the Event and sends it to the right outputPlugin for further processing

passDataToOutputPlugins is the main method of OutputManger. It is called whenever the output process has to be started

Parameters:

event - an Instance of Event

getAssociatedOutputExtension

public List<Identification> getAssociatedOutputExtension(OutputPluginModel<?,?> outputPlugin)

returns all the associated OutputExtensions

Parameters:

outputPlugin - the OutputPlugin to search for

Returns:

a List of Identifications

generateAllOutputExtensions

public <T,X> List<CompletableFuture<X>> generateAllOutputExtensions(OutputPluginModel<T,X> outputPlugin,
                                                                    T t,
                                                                    EventModel event)

starts every associated OutputExtension

Type Parameters:

T - the type of the argument

X - the return type

Parameters:

outputPlugin - the OutputPlugin to generate the Data for

t - the argument or null

event - the Event to generate for

Returns:

a List of Future-Objects