org.lsst.ccs.gconsole.plugins.monitor

Class CompoundView

java.lang.Object

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

org.lsst.ccs.gconsole.plugins.monitor.CompoundView

All Implemented Interfaces:

MonitorView, PersistableMonitorView, AgentStatusListener, Persistable, Savable

Direct Known Subclasses:

DefaultView

public class CompoundView
extends AbstractMonitorView1

A monitoring data view that manages several child views. Depending view modes:

• Listens to the status aggregator independently, with its own filter.
• Receives events filtered by the parent view filter.
• Has its AbstractMonitorView2 methods called by the parent view.

Calls to setFilter(...) are forwarded to children as well. That means children added before and after this call are treated differently.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompoundView.Descriptor JavaBean that contains information required to re-create this view in its current state.
static class	CompoundView.Mode Enumeration of management modes for child views.

Field Summary

Fields

Modifier and Type	Field and Description
protected CompoundView.Descriptor	descriptor

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

filter, formatter

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

CATEGORY

Constructor Summary

Constructors

Constructor and Description
CompoundView(JComponent panel)

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	addView(PersistableMonitorView view, CompoundView.Mode mode)
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 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.
CompoundView.Descriptor	getDescriptor() Returns a reference to the descriptor maintained by this component.
JComponent	getPanel() Returns the graphical component maintained by this view.
void	install() Installs this view, connecting it to the data source.
protected void	removeChannels(org.lsst.ccs.bus.data.AgentInfo agent, List<String> paths) Removes a channels from this view.
void	restore(Persistable.Descriptor descriptor) Restores this view to the state described by the provided descriptor, to the extent possible.
CompoundView.Descriptor	save() Returns a descriptor that contains information required to re-create this view in its current state.
void	setFilter(AgentChannelsFilter filter) Sets a channels filter.
void	statusChanged(AgentStatusEvent event) Called on status change.
void	uninstall() Un-installs this view, disconnecting it from the data source.
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

getFilter, getFormater, isChannelListFixed, setFormatter

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

edit, getName

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

isEmpty, setName

Methods inherited from interface org.lsst.ccs.gconsole.services.persist.Persistable

getCategory, restore

Field Detail

descriptor

protected CompoundView.Descriptor descriptor

Constructor Detail

CompoundView

public CompoundView(JComponent panel)

Method Detail

getPanel

public JComponent getPanel()

Returns the graphical component maintained by this view.

Returns:

Graphical component to be displayed by the GUI.

setFilter

public void setFilter(AgentChannelsFilter filter)

Sets a channels filter. The call is forwarded to children added in INDEPENDENT and FORWARD modes.

Specified by:

setFilter in interface MonitorView

Overrides:

setFilter in class AbstractMonitorView1

Parameters:

filter - Channels filter to be used by this view.

addView

public void addView(PersistableMonitorView view,
                    CompoundView.Mode mode)

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

Overrides:

connect in class AbstractMonitorView1

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

Specified by:

configure in interface AgentStatusListener

Overrides:

configure in class AbstractMonitorView1

Parameters:

event - Event.

statusChanged

public void statusChanged(AgentStatusEvent event)

Description copied from interface: AgentStatusListener

Called on status change.

Specified by:

statusChanged in interface AgentStatusListener

Overrides:

statusChanged in class AbstractMonitorView1

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

Overrides:

disconnect in class AbstractMonitorView1

Parameters:

event - Event.

connect

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

Overrides:

connect in class AbstractMonitorView1

disconnect

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

Overrides:

disconnect in class AbstractMonitorView1

addChannels

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

Description copied from class: AbstractMonitorView1

Adds channels to display.

Specified by:

addChannels in class AbstractMonitorView1

Parameters:

agent - Source agent.

channels - Map of display paths to channels.

removeChannels

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

Description copied from class: AbstractMonitorView1

Removes a channels from this view.

Specified by:

removeChannels in class AbstractMonitorView1

Parameters:

agent - Source agent.

paths - Display paths to remove.

updateChannels

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

Description copied from class: AbstractMonitorView1

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 display paths to key-value pairs, where the key is as AgentChannel object and the value is a list of changed attributes.

install

public void install()

Description copied from interface: MonitorView

Installs this view, connecting it to the data source.

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.

getDescriptor

public CompoundView.Descriptor getDescriptor()

Description copied from interface: Persistable

Returns a reference to the descriptor maintained by this component. Implementations are expected to ensure that this method never returns null, and that any properties set on the descriptor returned by this method are reflected by descriptors subsequently returned by save(), unless modified between the two calls.

Returns:

JavaBean describing this component.

save

public CompoundView.Descriptor save()

Returns a descriptor that contains information required to re-create this view in its current state.

Returns:

View descriptor.

restore

public void restore(Persistable.Descriptor descriptor)

Restores this view to the state described by the provided descriptor, to the extent possible.

Parameters:

descriptor - View descriptor.