kieker.analysis.plugin.reader.database
Class DbReader

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

All Implemented Interfaces:

IAnalysisComponent, IPlugin, IReaderPlugin

public class DbReader
extends AbstractReaderPlugin

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

Since:

1.5

Author:

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_CONNECTIONSTRING The name of the property containing the string to connect to the database.
static String	CONFIG_PROPERTY_NAME_DRIVERCLASSNAME The name of the property containing the class name of the driver.
static String	CONFIG_PROPERTY_NAME_TABLEPREFIX The name of the property containing the prefix for the tables to read.
static String	OUTPUT_PORT_NAME_RECORDS This is the name of the outport port delivering the records from the database.

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME

Constructor Summary

DbReader(Configuration configuration, IProjectContext projectContext)
Creates a new instance of this class using the given parameters.

Method Summary

Configuration	getCurrentConfiguration() 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.
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, getPluginDescription, getPluginName, getState, isConnectionAllowed, shutdown, start

Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface kieker.analysis.plugin.IPlugin

connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getName, getPluginDescription, getPluginName, getState

Field Detail

OUTPUT_PORT_NAME_RECORDS

public static final String OUTPUT_PORT_NAME_RECORDS

This is the name of the outport port delivering the records from the database.

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_DRIVERCLASSNAME

public static final String CONFIG_PROPERTY_NAME_DRIVERCLASSNAME

The name of the property containing the class name of the driver.

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_CONNECTIONSTRING

public static final String CONFIG_PROPERTY_NAME_CONNECTIONSTRING

The name of the property containing the string to connect to the database.

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_TABLEPREFIX

public static final String CONFIG_PROPERTY_NAME_TABLEPREFIX

The name of the property containing the prefix for the tables to read.

See Also:

Constant Field Values

Constructor Detail

DbReader

public DbReader(Configuration configuration,
                IProjectContext projectContext)
         throws Exception

Creates a new instance of this class using the given parameters.

Parameters:

configuration - The configuration for this component.

projectContext - The project context for this component.

Throws:

Exception - If the driver for the database could not be found.

Method Detail

read

public boolean read()

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)

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.

Parameters:

error - Determines whether the plugin is terminated due to an error or not.

getCurrentConfiguration

public Configuration getCurrentConfiguration()

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.

Specified by:

getCurrentConfiguration in interface IAnalysisComponent

Specified by:

getCurrentConfiguration in interface IPlugin

Specified by:

getCurrentConfiguration in class AbstractAnalysisComponent

Returns:

A completely filled configuration object.