org.lsst.ccs.gconsole.plugins.monitor

Class AbstractMonitorView2

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView1

org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView2

All Implemented Interfaces:

AgentStatusListener, MonitorView

Direct Known Subclasses:

SectionedTableView, TreeTableView, TreeView

public abstract class AbstractMonitorView2
extends AbstractMonitorView1

Adapter class that simplifies implementing monitor views.

Classes extending AbstractMonitorView2 should implement resetChannels() and, optionally,createChannelHandle(String, AgentChannel, Updatable), AbstractMonitorView1.connect(AgentInfo), and AbstractMonitorView1.disconnect(AgentInfo) methods.

As long as implementations of AgentStatusListener methods, addChannels(AgentInfo agent, Map), removeChannels(AgentInfo, List), and updateChannels(AgentInfo, Map) provided by this adapter are left unchanged, the view will be updated automatically in response to status aggregator events.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView1

AbstractMonitorView1.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedHashMap<String,ChannelHandle>	path2data

Fields inherited from class org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView1

descriptor, filter

Constructor Summary

Constructors

Constructor and Description
AbstractMonitorView2()

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.
protected ChannelHandle	createChannelHandle(String path, AgentChannel channel, Updatable view) Creates a new instance of ChannelHandle.
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 abstract void	resetChannels() Should be implemented to completely rebuild the view based on path2data field.
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 org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView1

configure, connect, connect, disconnect, disconnect, getDescriptor, getFilter, isChannelListFixed, restore, save, setFilter, statusChanged

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

path2data

protected final LinkedHashMap<String,ChannelHandle> path2data

Constructor Detail

AbstractMonitorView2

public AbstractMonitorView2()

Method Detail

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.

Returns:

True if this view has no content to display.

addChannels

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

Adds channels to display.

Specified by:

addChannels in class AbstractMonitorView1

Parameters:

agent - Source agent.

channels - Map of paths to channels.

removeChannels

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

Removes a channels from this view.

Specified by:

removeChannels in class AbstractMonitorView1

Parameters:

agent - Source agent.

paths - Paths to remove.

updateChannels

protected final 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.

Specified by:

updateChannels in class AbstractMonitorView1

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 abstract void resetChannels()

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

createChannelHandle

protected ChannelHandle createChannelHandle(String path,
                                            AgentChannel channel,
                                            Updatable view)

Creates a new instance of ChannelHandle. Called on EDT whenever channels are being added. Handles created by this method are put into path2data map.

The default 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.