org.lsst.ccs.gconsole.plugins.monitor

Class AbstractMonitorView

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView

All Implemented Interfaces:

AgentStatusListener, MonitorView

Direct Known Subclasses:

CompoundView, ConfigView, SectionedTableView, TabbedView, TreeTableView, TreeView

public abstract class AbstractMonitorView
extends Object
implements MonitorView

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractMonitorView.ChannelDisplay
static interface	AbstractMonitorView.ChannelHandle
static class	AbstractMonitorView.DefaultChannelHandle
static class	AbstractMonitorView.Descriptor JavaBean that contains information required to re-create this view in its current state.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractMonitorView.Descriptor	descriptor
protected AgentChannelsFilter	filter
protected LinkedHashMap<String,AbstractMonitorView.ChannelHandle>	path2data

Constructor Summary

Constructors

Constructor and Description
AbstractMonitorView()

Method Summary

Modifier and Type	Method and Description
protected void	addChannels(org.lsst.ccs.bus.data.AgentInfo agent, Map<String,AgentChannel> channels) Adds channels to display.
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.
protected void	connect(org.lsst.ccs.bus.data.AgentInfo agent)
void	connect(AgentStatusEvent event) Called when a new agent connects to the buses.
protected AbstractMonitorView.ChannelHandle	createChannelHandle(String path, AgentChannel channel, AbstractMonitorView.ChannelDisplay view) Creates a new instance of ChannelHandle.
protected void	disconnect(org.lsst.ccs.bus.data.AgentInfo agent)
void	disconnect(AgentStatusEvent event) Called when an agent disconnects from the buses or goes into OFFLINE state.
protected AbstractMonitorView.Descriptor	getDescriptor() Returns a reference to the descriptor maintained by this view.
AgentChannelsFilter	getFilter() Returns the filter associated with this view, or null if there is none.
protected boolean	isChannelListFixed()
boolean	isEmpty() Returns true if this view has no content to display at the moment.
protected void	removeChannels(org.lsst.ccs.bus.data.AgentInfo agent, List<String> paths) Removes a channels from this view.
protected void	resetChannels() Rebuilds the view based on path2data.
void	restore(MonitorView.Descriptor descriptor) Restores this view to the state described by the provided descriptor, to the extent possible.
AbstractMonitorView.Descriptor	save() Returns a descriptor that contains information required to re-create this view in its current state.
void	setFilter(AgentChannelsFilter filter) Sets the channels filter to be used by this view.
void	statusChanged(AgentStatusEvent event) Called on status change.
protected void	updateChannels(org.lsst.ccs.bus.data.AgentInfo agent, Map<String,Map.Entry<AgentChannel,List<String>>> channels) Called to notify this view that the specified channels have been updated.

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

getName, getPanel, install, setName, uninstall

Field Detail

filter

protected AgentChannelsFilter filter

descriptor

protected AbstractMonitorView.Descriptor descriptor

path2data

protected final LinkedHashMap<String,AbstractMonitorView.ChannelHandle> path2data

Constructor Detail

AbstractMonitorView

public AbstractMonitorView()

Method Detail

getFilter

public AgentChannelsFilter getFilter()

Description copied from interface: MonitorView

Returns the filter associated with this view, or null if there is none.

Specified by:

getFilter in interface MonitorView

Returns:

Channels filter.

setFilter

public void setFilter(AgentChannelsFilter filter)

Description copied from interface: MonitorView

Sets the channels filter to be used by this view. The filter determines what channels are displayed by this view, and how they are displayed.

Specified by:

setFilter in interface MonitorView

Parameters:

filter - Filter to be associated with this view.

isChannelListFixed

protected boolean isChannelListFixed()

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:

connect

public void connect(AgentStatusEvent event)

Description copied from interface: AgentStatusListener

Called when a new agent connects to the buses. Newly registered listeners are notified immediately if the agent is already connected.

The event passed to this method does not contain any information on channels (corresponding methods return empty collections) or a reference to a status message. The event can only be used to retrieve AgentInfo descriptor and a reference to the AgentStatusAggregator instance.

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

Specified by:

connect in interface AgentStatusListener

Parameters:

event - Event.

configure

public 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 triggered by a status message, getMessage() method returns null.

Specified by:

configure in interface AgentStatusListener

Parameters:

event - Event.

statusChanged

public void statusChanged(AgentStatusEvent event)

Description copied from interface: AgentStatusListener

Called on status change.

Specified by:

statusChanged in interface AgentStatusListener

Parameters:

event - event Event.

disconnect

public 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.

connect

protected void connect(org.lsst.ccs.bus.data.AgentInfo agent)

disconnect

protected void disconnect(org.lsst.ccs.bus.data.AgentInfo agent)

addChannels

protected void addChannels(org.lsst.ccs.bus.data.AgentInfo agent,
                           Map<String,AgentChannel> channels)

Adds channels to display.

Parameters:

agent - Source agent.

channels - Map of paths to channels.

removeChannels

protected void removeChannels(org.lsst.ccs.bus.data.AgentInfo agent,
                              List<String> paths)

Removes a channels from this view.

Parameters:

agent - Source agent.

paths - Paths to remove.

updateChannels

protected void updateChannels(org.lsst.ccs.bus.data.AgentInfo agent,
                              Map<String,Map.Entry<AgentChannel,List<String>>> channels)

Called to notify this view that the specified channels have been updated.

Parameters:

agent - Source agent.

channels - Map of paths to key-value pairs, where the key is as AgentChannel object and the value is a list of changed attributes.

resetChannels

protected void resetChannels()

Rebuilds the view based on path2data.

createChannelHandle

protected AbstractMonitorView.ChannelHandle createChannelHandle(String path,
                                                                AgentChannel channel,
                                                                AbstractMonitorView.ChannelDisplay view)

Creates a new instance of ChannelHandle. The implementation provided by this class creates an instance of DefaultChannelHandle. Subclasses may override this method to return a different implementation of ChannelHandle.

Parameters:

path - Display path.

channel - Agent channel.

view - View displaying the channel.

Returns:

New instance of ChannelHandle.

save

public AbstractMonitorView.Descriptor save()

Returns a descriptor that contains information required to re-create this view in its current state. The implementation provided by this class returns the descriptor previously set with restore(...).

Specified by:

save in interface MonitorView

Returns:

View descriptor, or null is this view does not support saving.

restore

public void restore(MonitorView.Descriptor descriptor)

Restores this view to the state described by the provided descriptor, to the extent possible. The implementation provided by this class stores the provided descriptor, so that it can be retrieved with save() later.

Specified by:

restore in interface MonitorView

Parameters:

descriptor - View descriptor.

getDescriptor

protected AbstractMonitorView.Descriptor getDescriptor()

Returns a reference to the descriptor maintained by this view. This is a convenience method intended to be overridden by subclasses to return an appropriate subtype of AbstractMonitorView.Descriptor.

Returns:

Descriptor maintained by this view.