xal.tools.correlator

Class PatientBroadcaster<RecordType>

java.lang.Object

xal.tools.correlator.PatientBroadcaster<RecordType>

All Implemented Interfaces:

BinListener<RecordType>

public class PatientBroadcaster<RecordType>
extends java.lang.Object

PatientBroadcaster posts only the best correlation (most records) for a given correlation time period. Smaller correlations for a given correlation time period are dropped. The effect is to post only mutually exclusive correlations.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	binTimespan
protected CorrelationFilter<RecordType>	correlationFilter
protected CorrelationNotice<RecordType>	correlationProxy
protected int	fullCount
protected double	lastTime
protected Correlation<RecordType>	pendingCorrelation

Constructor Summary

Constructors

Constructor and Description
PatientBroadcaster(MessageCenter aLocalCenter) Creates a new instance of PatientBroadcaster

Method Summary

Modifier and Type	Method and Description
void	addCorrelationNoticeListener(CorrelationNotice<RecordType> listener) Register the listener as a receiver of Correlation notices from this correlator.
void	binTimespanChanged(Correlator<?,RecordType,?> sender, double newTimespan) Handle the bin timespan changed event.
void	correlationFilterChanged(Correlator<?,RecordType,?> sender, CorrelationFilter<RecordType> newFilter) Handle the correlation filter changed event.
void	newCorrelation(BinAgent<RecordType> sender, Correlation<RecordType> correlation) Handle the BinListener event and determine if we should cache it or post it.
protected void	postCorrelation(Correlation<RecordType> correlation) Post the correlation.
void	removeCorrelationNoticeListener(CorrelationNotice<RecordType> listener) Unregister the listener as a receiver of Correlation notices from this correlator.
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.
void	willReset(BinAgent<RecordType> sender) Implement BinListener interface.
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

binTimespan

protected double binTimespan

lastTime

protected double lastTime

pendingCorrelation

protected Correlation<RecordType> pendingCorrelation

fullCount

protected transient int fullCount

correlationProxy

protected CorrelationNotice<RecordType> correlationProxy

correlationFilter

protected CorrelationFilter<RecordType> correlationFilter

Constructor Detail

PatientBroadcaster

public PatientBroadcaster(MessageCenter aLocalCenter)

Creates a new instance of PatientBroadcaster

Method Detail

newCorrelation

public void newCorrelation(BinAgent<RecordType> sender,
                           Correlation<RecordType> correlation)

Handle the BinListener event and determine if we should cache it or post it.

Specified by:

newCorrelation in interface BinListener<RecordType>

Parameters:

sender - The bin agent that published the new correlation.

correlation - The new correlation.

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.

addCorrelationNoticeListener

public void addCorrelationNoticeListener(CorrelationNotice<RecordType> listener)

Register the listener as a receiver of Correlation notices from this correlator.

removeCorrelationNoticeListener

public void removeCorrelationNoticeListener(CorrelationNotice<RecordType> listener)

Unregister the listener as a receiver of Correlation notices from this correlator.

postCorrelation

protected void postCorrelation(Correlation<RecordType> correlation)

Post the correlation.

Parameters:

correlation - The correlation to post.

willReset

public void willReset(BinAgent<RecordType> sender)

Implement BinListener interface. This method does nothing.

Specified by:

willReset in interface BinListener<RecordType>

Parameters:

sender - The bin agent who sent this message.

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.

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)

Handle the correlation filter changed event.

Parameters:

sender - The correlator whose correlation filter has changed.

newFilter - The new correlation filter to use.