kieker.analysis.plugin.reader.database
Class DbReader

java.lang.Object
  kieker.analysis.plugin.AbstractPlugin
      kieker.analysis.plugin.reader.AbstractReaderPlugin
          kieker.analysis.plugin.reader.database.DbReader

All Implemented Interfaces:

IPlugin, IReaderPlugin

public class DbReader
extends AbstractReaderPlugin

A very simple database reader that probably only works for small data sets.

Author:

Jan Waller

Nested Class Summary

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

IPlugin.PluginInputPortReference

Field Summary

static String	CONFIG_PROPERTY_NAME_CONNECTIONSTRING
static String	CONFIG_PROPERTY_NAME_DRIVERCLASSNAME
static String	CONFIG_PROPERTY_NAME_TABLEPREFIX
static String	OUTPUT_PORT_NAME_RECORDS

Fields inherited from class kieker.analysis.plugin.AbstractPlugin

CONFIG_NAME

Constructor Summary

DbReader(Configuration configuration)

Method Summary

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

Methods inherited from class kieker.analysis.plugin.AbstractPlugin

areAllRepositoryPortsConnected, connect, connect, getAllInputPortNames, getAllOutputPortNames, getConnectedPlugins, getCurrentRepositories, getName, getPluginDescription, getPluginName, isConnectionAllowed

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_PORT_NAME_RECORDS

public static final String OUTPUT_PORT_NAME_RECORDS

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_DRIVERCLASSNAME

public static final String CONFIG_PROPERTY_NAME_DRIVERCLASSNAME

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_CONNECTIONSTRING

public static final String CONFIG_PROPERTY_NAME_CONNECTIONSTRING

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_TABLEPREFIX

public static final String CONFIG_PROPERTY_NAME_TABLEPREFIX

See Also:

Constant Field Values

Constructor Detail

DbReader

public DbReader(Configuration configuration)
         throws Exception

Throws:

Exception

Method Detail

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 IReaderPlugin.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: IReaderPlugin

Initiates a termination of the reader. This method is only used by the framework and should not be called manually to register a receiver. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the reader should terminate its IReaderPlugin.read() method.

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.