Kieker 1.10

kieker.analysis.plugin.filter.forward
Class ListCollectionFilter<T>

java.lang.Object
  extended by kieker.analysis.analysisComponent.AbstractAnalysisComponent
      extended by kieker.analysis.plugin.AbstractPlugin
          extended by kieker.analysis.plugin.filter.AbstractFilterPlugin
              extended by kieker.analysis.plugin.filter.forward.ListCollectionFilter<T>
Type Parameters:
T - The type of the list.
All Implemented Interfaces:
IAnalysisComponent, IFilterPlugin, IPlugin

public class ListCollectionFilter<T>
extends AbstractFilterPlugin

This filter collects the incoming objects in a simple synchronized list. It is mostly used for test purposes.

Since:
1.6
Author:
Nils Christian Ehmke, Jan Waller, Bjoern Weissenfels

Nested Class Summary
static class ListCollectionFilter.ListFullBehavior
          An enum for all possible list full behaviors.
 
Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin
IPlugin.PluginInputPortReference, IPlugin.STATE
 
Field Summary
static String CONFIG_PROPERTY_NAME_LIST_FULL_BEHAVIOR
          The name of the property determining the behavior of a full list.
static String CONFIG_PROPERTY_NAME_MAX_NUMBER_OF_ENTRIES
          The name of the property determining the maximal number of allowed entries.
static String CONFIG_PROPERTY_VALUE_LIST_FULL_BEHAVIOR
          The default value for the behavior of a full list (drop oldest).
static String CONFIG_PROPERTY_VALUE_NUMBER_OF_ENTRIES
          The default value for the maximal number of allowed entries (unlimited.
static String INPUT_PORT_NAME
          The name of the input port for the incoming objects.
static String OUTPUT_PORT_NAME
          The name of the output port for the forwarded objects.
 
Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
CONFIG_NAME
 
Constructor Summary
ListCollectionFilter(Configuration configuration, IProjectContext projectContext)
          Creates a new instance of this class using the given parameters.
 
Method Summary
 void clear()
          Clears the list.
 Configuration getCurrentConfiguration()
          This method should deliver a Configuration object containing the current configuration of this instance.
 List<T> getList()
          Delivers a copy of the internal list.
 void input(T data)
          This method represents the input port.
 int size()
           
 
Methods inherited from class kieker.analysis.plugin.filter.AbstractFilterPlugin
init, terminate
 
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

INPUT_PORT_NAME

public static final String INPUT_PORT_NAME
The name of the input port for the incoming objects.

See Also:
Constant Field Values

OUTPUT_PORT_NAME

public static final String OUTPUT_PORT_NAME
The name of the output port for the forwarded objects.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_MAX_NUMBER_OF_ENTRIES

public static final String CONFIG_PROPERTY_NAME_MAX_NUMBER_OF_ENTRIES
The name of the property determining the maximal number of allowed entries.

See Also:
Constant Field Values

CONFIG_PROPERTY_VALUE_NUMBER_OF_ENTRIES

public static final String CONFIG_PROPERTY_VALUE_NUMBER_OF_ENTRIES
The default value for the maximal number of allowed entries (unlimited.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_LIST_FULL_BEHAVIOR

public static final String CONFIG_PROPERTY_NAME_LIST_FULL_BEHAVIOR
The name of the property determining the behavior of a full list.

See Also:
Constant Field Values

CONFIG_PROPERTY_VALUE_LIST_FULL_BEHAVIOR

public static final String CONFIG_PROPERTY_VALUE_LIST_FULL_BEHAVIOR
The default value for the behavior of a full list (drop oldest).

See Also:
Constant Field Values
Constructor Detail

ListCollectionFilter

public ListCollectionFilter(Configuration configuration,
                            IProjectContext projectContext)
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.
Method Detail

input

public void input(T data)
This method represents the input port.

Parameters:
data - The next element.

clear

public void clear()
Clears the list.


getList

public List<T> getList()
Delivers a copy of the internal list.

Returns:
The content of the internal list.

size

public int size()
Returns:
The current number of collected objects.

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.

Kieker 1.10

Copyright 2014 Kieker Project, http://kieker-monitoring.net