kieker.analysis.plugin.reader.list
Class ListReader<T>

java.lang.Object
  kieker.analysis.plugin.AbstractPlugin
      kieker.analysis.plugin.reader.AbstractReaderPlugin
          kieker.analysis.plugin.reader.list.ListReader<T>

Type Parameters:

T -

All Implemented Interfaces:

IPlugin, IReaderPlugin

public class ListReader<T>
extends AbstractReaderPlugin

Helper class that reads records added using the methods addAllObjects(List) or addObject(Object). Depending on the value of the Configuration variable "awaitTermination", either the read() method returns immediately, or awaits a termination via AnalysisController.terminate().

Author:

Andre van Hoorn, Jan Waller

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin

IPlugin.PluginInputPortReference, IPlugin.STATE

Field Summary

static String	CONFIG_PROPERTY_NAME_AWAIT_TERMINATION
static String	OUTPUT_PORT_NAME

Fields inherited from class kieker.analysis.plugin.AbstractPlugin

CONFIG_NAME

Constructor Summary

ListReader(Configuration configuration)

Method Summary

void	addAllObjects(List<T> records)
void	addObject(T object)
Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
boolean	read() Starts the reader.
void	terminate(boolean error) Initiates a termination of the plugin.

Methods inherited from class kieker.analysis.plugin.reader.AbstractReaderPlugin

init

Methods inherited from class kieker.analysis.plugin.AbstractPlugin

areAllRepositoryPortsConnected, connect, connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getIncomingPlugins, getName, getPluginDescription, getPluginName, getState, isConnectionAllowed, shutdown, start

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_PORT_NAME

public static final String OUTPUT_PORT_NAME

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_AWAIT_TERMINATION

public static final String CONFIG_PROPERTY_NAME_AWAIT_TERMINATION

See Also:

Constant Field Values

Constructor Detail

ListReader

public ListReader(Configuration configuration)

Method Detail

addAllObjects

public void addAllObjects(List<T> records)

addObject

public void addObject(T object)

read

public boolean read()

Description copied from interface: IReaderPlugin

Starts the reader. This method is intended to be a blocking operation, i.e., it is assumed that reading has finished before this method returns. The method should indicate an error by the return value false. In asynchronous scenarios, the IPlugin.terminate(boolean) method can be used to initiate the termination of this method.

Returns:

true if reading was successful; false if an error occurred

terminate

public void terminate(boolean error)

Description copied from interface: IPlugin

Initiates a termination of the plugin. This method is only used by the framework and should not be called manually. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the plugin should terminate any running methods, e.g., read for readers.

getCurrentConfiguration

public Configuration getCurrentConfiguration()

Description copied from interface: IPlugin

This method should deliver a Configuration object containing the current configuration of this instance. In other words: The constructor should be able to use the given object to initialize a new instance of this class with the same intern properties.

Returns:

A completely filled configuration object.