org.lsst.ccs.gconsole.plugins.monitor

Class AbstractMonitorView3

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView3

All Implemented Interfaces:

MonitorView, AgentStatusListener

Direct Known Subclasses:

SummaryTableView, TestView3

public abstract class AbstractMonitorView3
extends Object
implements MonitorView

Adapter class that simplifies implementing monitor views.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedHashMap<String,DisplayChannel>	data

Fields inherited from interface org.lsst.ccs.gconsole.plugins.monitor.MonitorView

CATEGORY

Constructor Summary

Constructors

Constructor and Description
AbstractMonitorView3()

Method Summary

Modifier and Type	Method and Description
void	configure(AgentStatusEvent event) Called when the complete static information on the source agent (including channels dictionary) becomes available for the first time, and when it changes.
void	disconnect(AgentStatusEvent event) Called when an agent disconnects from the buses or goes into OFFLINE state.
void	install() Installs this view, connecting it to the data source.
boolean	isEmpty() Returns true if this view has no content to display at the moment.
protected abstract void	resetChannels() Called on EDT whenever channels have been added or removed.
void	statusChanged(AgentStatusEvent event) Called on status change.
void	uninstall() Un-installs this view, disconnecting it from the data source.
protected void	update() Called on EDT at the end of each update, after all DisplayChannel.update(...) methods.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.gconsole.plugins.monitor.MonitorView

getFilter, getFormater, getName, getPanel, setFilter, setFormatter, setName

Methods inherited from interface org.lsst.ccs.gconsole.services.aggregator.AgentStatusListener

connect

Field Detail

data

protected final LinkedHashMap<String,DisplayChannel> data

Constructor Detail

AbstractMonitorView3

public AbstractMonitorView3()

Method Detail

resetChannels

protected abstract void resetChannels()

Called on EDT whenever channels have been added or removed. Should be implemented to completely rebuild the view based on data field.

update

protected void update()

Called on EDT at the end of each update, after all DisplayChannel.update(...) methods. Empty implementation is provided.

isEmpty

public boolean isEmpty()

Description copied from interface: MonitorView

Returns true if this view has no content to display at the moment. This can be used report that the view can be closed, for example. The default implementation returns false.

Specified by:

isEmpty in interface MonitorView

Returns:

True if this view has no content to display.

configure

public final void configure(AgentStatusEvent event)

Description copied from interface: AgentStatusListener

Called when the complete static information on the source agent (including channels dictionary) becomes available for the first time, and when it changes. Newly registered listeners are notified immediately if the information is already available.

The event passed to this method contains a list of added channels. Methods accessing lists of changed and removed channels will return empty collections. Since the configuration event is not necessarily triggered by a status message, getMessage() method returns null.

Specified by:

configure in interface AgentStatusListener

Parameters:

event - Event.

disconnect

public final void disconnect(AgentStatusEvent event)

Description copied from interface: AgentStatusListener

Called when an agent disconnects from the buses or goes into OFFLINE state.

The event passed to this method does not contain any information on channels status - corresponding methods return empty collections. Since the disconnection event might or might not be triggered by a status message, getMessage() method might return null.

The implementation should return quickly. Any blocking operations should be scheduled on a separate thread.

Specified by:

disconnect in interface AgentStatusListener

Parameters:

event - Event.

statusChanged

public final void statusChanged(AgentStatusEvent event)

Description copied from interface: AgentStatusListener

Called on status change.

Specified by:

statusChanged in interface AgentStatusListener

Parameters:

event - event Event.

install

public void install()

Description copied from interface: MonitorView

Installs this view, connecting it to the data source.

Specified by:

install in interface MonitorView

uninstall

public void uninstall()

Description copied from interface: MonitorView

Un-installs this view, disconnecting it from the data source. Uninstalling a view that has not been installed should have no effect.

Specified by:

uninstall in interface MonitorView