xal.tools.correlator

Class SourceAgent<RecordType>

java.lang.Object

xal.tools.correlator.SourceAgent<RecordType>

Direct Known Subclasses:

ChannelAgent

public abstract class SourceAgent<RecordType>
extends java.lang.Object

Generator manages a single channel. It performs any setup, monitors the channel and it manages a circular buffer of bin agents that gather correlated events.

Field Summary

Fields

Modifier and Type	Field and Description
protected xal.tools.correlator.BinUpdate<RecordType>	_binUpdateProxy proxy to forward bin update events to registered listeners
protected java.lang.String	_name unique name of this source agent

Constructor Summary

Constructors

Constructor and Description
SourceAgent(MessageCenter messageCenter, java.lang.String name, RecordFilter<RecordType> recordFilter, CorrelationTester<RecordType> tester) Creates new ChannelAgent

Method Summary

Modifier and Type	Method and Description
void	binTimespanChanged(Correlator<?,RecordType,?> sender, double newTimespan) Handle the bin timespan changed event.
void	correlationFilterChanged(Correlator<?,RecordType,?> sender, CorrelationFilter<RecordType> newFilter) Implement StateNotice interface to listen for change of state
java.lang.String	name() Name of the managed source
protected void	postEvent(RecordType record, double timestamp) This method is used to advertise a new event record received by the event handler of the SourceAgent subclass.
void	reset() clear memory of all events
void	setBinTimespan(double timespan) Set the timespan to each bin
protected abstract void	setupEventHandler(RecordFilter<RecordType> recordFilter) Subclasses implement this method to handle the monitoring of its sources in a way specific to the particular SourceAgent subclass.
protected void	shutdown() shutdown this channel agent and remove itself
void	sourceAdded(Correlator<?,RecordType,?> sender, java.lang.String name, int newCount) Handle the source added event.
void	sourceRemoved(Correlator<?,RecordType,?> sender, java.lang.String name, int newCount) Handle the source removed event.
abstract boolean	startMonitor() Start monitoring the channel
abstract void	stopMonitor() Stop monitoring the channel
void	willStartMonitoring(Correlator<?,RecordType,?> sender) Handle the advance notice of the correlator starting.
void	willStopMonitoring(Correlator<?,RecordType,?> sender) Handle the advance notice of the correlator stopping.

Methods inherited from class java.lang.Object

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

Field Detail

_name

protected java.lang.String _name

unique name of this source agent

_binUpdateProxy

protected xal.tools.correlator.BinUpdate<RecordType> _binUpdateProxy

proxy to forward bin update events to registered listeners

Constructor Detail

SourceAgent

public SourceAgent(MessageCenter messageCenter,
                   java.lang.String name,
                   RecordFilter<RecordType> recordFilter,
                   CorrelationTester<RecordType> tester)

Creates new ChannelAgent

Method Detail

setupEventHandler

protected abstract void setupEventHandler(RecordFilter<RecordType> recordFilter)

Subclasses implement this method to handle the monitoring of its sources in a way specific to the particular SourceAgent subclass. When an event is captured and it passes the filter test, this method should call postEvent().

Parameters:

recordFilter - filter for records to accept or reject

See Also:

postEvent(RecordType, double)

reset

public void reset()

clear memory of all events

setBinTimespan

public void setBinTimespan(double timespan)

Set the timespan to each bin

Parameters:

timespan - for each bin

postEvent

protected final void postEvent(RecordType record,
                               double timestamp)

This method is used to advertise a new event record received by the event handler of the SourceAgent subclass. When an event record has passed the the filter test it should be posted via this method so that other stakeholders (i.e. the bin agents) can handle the event properly.

Parameters:

record - for which the event was posted

timestamp - for which the event was posted

name

public java.lang.String name()

Name of the managed source

Returns:

name of the managed source

startMonitor

public abstract boolean startMonitor()

Start monitoring the channel

Returns:

true upon success and false upon failure

stopMonitor

public abstract void stopMonitor()

Stop monitoring the channel

shutdown

protected void shutdown()

shutdown this channel agent and remove itself

sourceAdded

public void sourceAdded(Correlator<?,RecordType,?> sender,
                        java.lang.String name,
                        int newCount)

Handle the source added event.

Parameters:

sender - The correlator to which the source has been added.

name - The name identifying the new source.

newCount - The new number of sources correlated.

sourceRemoved

public void sourceRemoved(Correlator<?,RecordType,?> sender,
                          java.lang.String name,
                          int newCount)

Handle the source removed event.

Parameters:

sender - The correlator from which the source has been removed.

name - The name identifying the new source.

newCount - The new number of sources correlated.

binTimespanChanged

public void binTimespanChanged(Correlator<?,RecordType,?> sender,
                               double newTimespan)

Handle the bin timespan changed event.

Parameters:

sender - The correlator whose timespan bin has changed.

newTimespan - The new timespan used by the correlator.

willStopMonitoring

public void willStopMonitoring(Correlator<?,RecordType,?> sender)

Handle the advance notice of the correlator stopping.

Parameters:

sender - The correlator that will stop.

willStartMonitoring

public void willStartMonitoring(Correlator<?,RecordType,?> sender)

Handle the advance notice of the correlator starting.

Parameters:

sender - The correlator that will start.

correlationFilterChanged

public void correlationFilterChanged(Correlator<?,RecordType,?> sender,
                                     CorrelationFilter<RecordType> newFilter)

Implement StateNotice interface to listen for change of state

Parameters:

sender - The correlator whose correlation filter has changed.

newFilter - The new correlation filter to use.