org.intellimate.izou.sdk.output

Class OutputPluginArgument<T,X>

java.lang.Object

org.intellimate.izou.sdk.util.AddOnModule

org.intellimate.izou.sdk.output.OutputPluginArgument<T,X>

Type Parameters:

T - the type of the Argument

X - the return type

All Implemented Interfaces:

Runnable, Identifiable, OutputPluginModel<T,X>, ContextProvider, Loggable, LoggedExceptionCallback, ThreadPoolUser, ExceptionCallback

Direct Known Subclasses:

OutputPlugin

public abstract class OutputPluginArgument<T,X>
extends AddOnModule
implements OutputPluginModel<T,X>, ThreadPoolUser

The OutputPlugin class gets Event and then starts threads filled with output-extension tasks to create the final output and then render it on its own medium

Field Summary

Fields inherited from interface org.intellimate.izou.sdk.util.Loggable

FQCN

Constructor Summary

Constructors

Constructor and Description
OutputPluginArgument(Context context, String id) creates a new output-plugin with a new id

Method Summary

Modifier and Type	Method and Description
void	addToEventList(EventModel event) Adds an event to blockingQueue
EventModel	blockingQueueHandling() Default implementation waits until a new Event has been received and then processes it.
abstract T	getArgument() returns the argument for the OutputExtensions
com.google.common.reflect.TypeToken<T>	getArgumentType() returns the Type of the argument for the OutputExtensions, or null if none
BlockingQueue<EventModel>	getEventBlockingQueue() gets the blocking-queue that stores the backlog of Events
List<Identification>	getOutputExtensionList() get the outputExtensionList
com.google.common.reflect.TypeToken<X>	getReceivingType() returns the Type of the one wants to receive from the OutputExtensions
int	getTimeoutLimit() gets the timeout-limit in Milliseconds
void	handleFutures(List<CompletableFuture<X>> futures, EventModel eventModel)
void	isDone(EventModel event)
boolean	isRunning()
void	outputExtensionAdded(Identification identification) callback method to notify that an OutputExtension was added
void	outputExtensionRemoved(Identification identification) callback method to notify that an OutputExtension was added
abstract void	renderFinalOutput(List<X> data, EventModel eventModel) method that uses tDoneList to generate a final output that will then be rendered.
void	run() main method for outputPlugin, runs the data-conversion and output-renderer it will instruct the outputManager to let the outputExtensions generate the data.
void	stop()
void	terminate() terminates the outputPlugin (will not listen to events anymore)

Methods inherited from class org.intellimate.izou.sdk.util.AddOnModule

getContext, getID

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.identification.Identifiable

getID, isOwner

Methods inherited from interface org.intellimate.izou.sdk.util.ThreadPoolUser

submit, submit, submit, submitRun, timeOut, timeOut

Methods inherited from interface org.intellimate.izou.sdk.util.ContextProvider

debug, debug, error, error, getContext

Methods inherited from interface org.intellimate.izou.sdk.util.Loggable

debug, debug, error, error, fatal, fatal, warn, warn

Methods inherited from interface org.intellimate.izou.sdk.util.LoggedExceptionCallback

exceptionThrown

Constructor Detail

OutputPluginArgument

public OutputPluginArgument(Context context,
                            String id)

creates a new output-plugin with a new id

Parameters:

context - context

id - the id of the new output-plugin

Method Detail

getOutputExtensionList

public List<Identification> getOutputExtensionList()

get the outputExtensionList

Returns:

gets the list of output-extensions in the output-plugin

getEventBlockingQueue

public BlockingQueue<EventModel> getEventBlockingQueue()

gets the blocking-queue that stores the backlog of Events

Returns:

blocking-queue that stores Events

outputExtensionAdded

public void outputExtensionAdded(Identification identification)

callback method to notify that an OutputExtension was added

Specified by:

outputExtensionAdded in interface OutputPluginModel<T,X>

Parameters:

identification - the Identification of the OutputExtension added

outputExtensionRemoved

public void outputExtensionRemoved(Identification identification)

callback method to notify that an OutputExtension was added

Specified by:

outputExtensionRemoved in interface OutputPluginModel<T,X>

Parameters:

identification - the Identification of the OutputExtension added

getReceivingType

public com.google.common.reflect.TypeToken<X> getReceivingType()

returns the Type of the one wants to receive from the OutputExtensions

Specified by:

getReceivingType in interface OutputPluginModel<T,X>

Returns:

the type of the generic

getArgumentType

public com.google.common.reflect.TypeToken<T> getArgumentType()

returns the Type of the argument for the OutputExtensions, or null if none

Specified by:

getArgumentType in interface OutputPluginModel<T,X>

Returns:

the type of the Argument

addToEventList

public void addToEventList(EventModel event)

Adds an event to blockingQueue

Specified by:

addToEventList in interface OutputPluginModel<T,X>

Parameters:

event - the event to add

Throws:

IllegalStateException - raised if problems adding an event to blockingQueue

isRunning

public boolean isRunning()

Specified by:

isRunning in interface OutputPluginModel<T,X>

stop

public void stop()

Specified by:

stop in interface OutputPluginModel<T,X>

isDone

public void isDone(EventModel event)

Parameters:

event - the current processed Event

terminate

public void terminate()

terminates the outputPlugin (will not listen to events anymore)

handleFutures

public void handleFutures(List<CompletableFuture<X>> futures,
                          EventModel eventModel)

run

public void run()

main method for outputPlugin, runs the data-conversion and output-renderer it will instruct the outputManager to let the outputExtensions generate the data. Wait for the time specified in getTimeoutLimit() (standard is 1000 milliseconds) abd the call renderFinalOutput() with the resulting data.

Specified by:

run in interface Runnable

blockingQueueHandling

public EventModel blockingQueueHandling()
                                 throws InterruptedException

Default implementation waits until a new Event has been received and then processes it. This method is made to be overwritten as seen fit by the developer

Returns:

the recently added Event-instance to be processed by the outputPlugin

Throws:

InterruptedException - if interrupted while waiting

getTimeoutLimit

public int getTimeoutLimit()

gets the timeout-limit in Milliseconds

Returns:

timeout in milliseconds

renderFinalOutput

public abstract void renderFinalOutput(List<X> data,
                                       EventModel eventModel)

method that uses tDoneList to generate a final output that will then be rendered.

Parameters:

data - the data generated

eventModel - the Event which caused the whole thing

getArgument

public abstract T getArgument()

returns the argument for the OutputExtensions

Returns:

the argument