org.lsst.ccs.gconsole.plugins.monitor

Class CompoundView

java.lang.Object

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

All Implemented Interfaces:

MonitorView, PersistableMonitorView, AgentStatusListener, Persistable, Savable

Direct Known Subclasses:

DefaultView

public class CompoundView
extends Object
implements PersistableMonitorView

A monitoring data view that manages several child views. This class is primarily intended as a base class for specific compound views (see DefaultView for an example of use).

The current implementation supports two simple child view modes:

INDEPENDENT

Listens to the status aggregator independently, with its own filter.

FORWARD

Receives events forwarded by the parent view filter.

In the future, more complex modes calling AbstractMonitorView SPI on child views can be added if necessary.

Calls to setFilter(...) are forwarded to children as well. That means children added before and after this call are treated differently. All setters should be called before install().

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 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
void	addView(PersistableMonitorView view, CompoundView.Mode mode)
void	configure(AgentStatusEvent event) Called when the source agent reaches OPERATIONAL state and its all static information (including channels dictionary) becomes available.
void	connect(AgentStatusEvent event) Called when a new agent connects to the buses.
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.
AgentChannelsFilter	getFilter() Returns the filter associated with this view, or null if there is none.
JComponent	getPanel() Returns the graphical component maintained by this view.
void	install() Installs this view, connecting it to the data source.
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 data change.
void	uninstall() Uninstalls this view, disconnecting it from the data source.

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

getFormater, isEmpty, setFormatter, setName

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

getCategory, getPath, 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.

Specified by:

getPanel in interface MonitorView

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

Parameters:

filter - Channels filter to be used by this view.

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.

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.

Specified by:

connect in interface AgentStatusListener

Parameters:

event - Event.

configure

public void configure(AgentStatusEvent event)

Description copied from interface: AgentStatusListener

Called when the source agent reaches OPERATIONAL state and its all static information (including channels dictionary) becomes available. 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.

statusChanged

public void statusChanged(AgentStatusEvent event)

Description copied from interface: AgentStatusListener

Called on data 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 have any added or modified channels, but all previously existing channels are listed as removed. Since the disconnection event might or might not be triggered by a status message, getMessage() method might return null.

Specified by:

disconnect in interface AgentStatusListener

Parameters:

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

Uninstalls 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

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.

Specified by:

getDescriptor in interface Persistable

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.

Specified by:

save in interface Persistable

Specified by:

save in interface Savable

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.

Specified by:

restore in interface Persistable

Parameters:

descriptor - View descriptor.