org.lsst.ccs.gconsole.plugins.monitor

Class AbstractMonitorView

java.lang.Object

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

All Implemented Interfaces:

MonitorView, PersistableMonitorView, AgentStatusListener, Persistable, Savable

Direct Known Subclasses:

ConfigView, GroupView, LazyTreeView, SectionedTableView, SummaryTableView, TabbedView, TreeView

public abstract class AbstractMonitorView
extends Object
implements PersistableMonitorView

An adapter that simplifies implementing MonitorView.

Provided implementation of the AgentStatusListener should not be overridden. Subclasses should override one of the two sets of methods (both called on EDT):

• addChannels(...), updateChannels(...), and removeChannels(...)
• resetChannels(), update(), and, optionally, createChannel(...). Implementations can use data field that contains a map of display paths to display channels.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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 List<MonitorField>	compactFields
protected LinkedHashMap<String,DisplayChannel>	data Map of display paths to display channels, to be used by subclasses to populate the view.
protected List<MonitorField>	fields
protected PersistableAgentChannelsFilter	filter
protected MonitorFormat	formatter

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

CATEGORY

Constructor Summary

Constructors

Constructor and Description
AbstractMonitorView()

Method Summary

Modifier and Type	Method and Description
void	addChannels(List<org.lsst.ccs.bus.data.AgentInfo> agents, List<Map.Entry<String,AgentChannel>> channels) Adds channels to this view.
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.
protected DisplayChannel	createChannel(String displayPath) Called on EDT to create new display channels whenever this view is informed of new display paths.
void	disconnect(AgentStatusEvent event) Called when an agent disconnects from the buses or goes into OFFLINE state.
abstract AbstractMonitorView.Descriptor	getDescriptor() Returns a reference to the descriptor maintained by this component.
PersistableAgentChannelsFilter	getFilter() Returns the filter associated with this view, or null if there is none.
MonitorFormat	getFormater() Returns formatter associated with this view, if any.
String	getGroup(String displayPath) Computes group name based on the display path returned by the filter.
List<MonitorField>	getGroupFields() Retrieves a list MonitorField for display channel groups from the filter.
List<String>	getGroups()
boolean	isEmpty() Returns true if this view has no channels to display.
void	removeChannels(List<org.lsst.ccs.bus.data.AgentInfo> agents, List<Map.Entry<String,AgentChannel>> channels) Removes channels from this view.
protected void	resetChannels() Called on EDT whenever channels have been added or removed.
AbstractMonitorView.Descriptor	save() Returns JavaBean describing the current state of this component.
void	setDiscardRemovedChannels(boolean discardRemovedChannels) Sets the policy on dealing with channels reported as removed by the status aggregator.
void	setFilter(AgentChannelsFilter filter) Sets the channels filter to be used by this view.
void	setFormatter(MonitorFormat formatter) Associates a formatter with this view.
void	statusChanged(AgentStatusEvent event) Called on data change.
protected void	update() Called on EDT at the end of each update, after all DisplayChannel.update(...) methods.
void	updateChannels(List<Map.Entry<String,Map.Entry<AgentChannel,List<String>>>> channels) Updates channels in this view.

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

getPanel, install, setName, uninstall

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

getCategory, getPath, restore, restore

Field Detail

filter

protected PersistableAgentChannelsFilter filter

formatter

protected MonitorFormat formatter

fields

protected List<MonitorField> fields

compactFields

protected List<MonitorField> compactFields

data

protected final LinkedHashMap<String,DisplayChannel> data

Map of display paths to display channels, to be used by subclasses to populate the view. In addition order.

Constructor Detail

AbstractMonitorView

public AbstractMonitorView()

Method Detail

setDiscardRemovedChannels

public void setDiscardRemovedChannels(boolean discardRemovedChannels)

Sets the policy on dealing with channels reported as removed by the status aggregator. If true, the channels are immediately removed from the data map. If false (default), the channels are retained until and unless an identically named agent appears in future status aggregator events.

Parameters:

discardRemovedChannels - Policy value.

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.

addChannels

public void addChannels(List<org.lsst.ccs.bus.data.AgentInfo> agents,
                        List<Map.Entry<String,AgentChannel>> channels)

Adds channels to this view. Any previously existing channels from the same agents are removed.

Parameters:

agents - Newly connected agents these channels belong to.

channels - New channels, each entry contains display path and channel.

updateChannels

public void updateChannels(List<Map.Entry<String,Map.Entry<AgentChannel,List<String>>>> channels)

Updates channels in this view.

Parameters:

channels - Updated channels, each element contains: {display path : {channel : list of modified attributes}}.

removeChannels

public void removeChannels(List<org.lsst.ccs.bus.data.AgentInfo> agents,
                           List<Map.Entry<String,AgentChannel>> channels)

Removes channels from this view. If the discardRemovedChannels flag is not set, the channels are updated but not removed.

Parameters:

agents - Names of disconnected agents.

channels - Removed channels, each entry contains display path and channel.

resetChannels

protected void resetChannels()

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

update

protected void update()

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

createChannel

protected DisplayChannel createChannel(String displayPath)

Called on EDT to create new display channels whenever this view is informed of new display paths. The default implementation constructs an instance of DisplayChannelMulti without any Updatable target.

Parameters:

displayPath - Display path.

Returns:

An instance of DisplayChannel to be put into the data map for the specified display path key.

isEmpty

public boolean isEmpty()

Returns true if this view has no channels to display. Implemented to return true if the data map is empty.

Specified by:

isEmpty in interface MonitorView

Returns:

True if this view has no display channels.

getGroup

public String getGroup(String displayPath)

Computes group name based on the display path returned by the filter. The default implementation splits around the last "/".

Parameters:

displayPath - Display path.

Returns:

Group name, or null if this display path does not belong to any group.

getGroups

public List<String> getGroups()

getFilter

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

getFormater

public MonitorFormat getFormater()

Description copied from interface: MonitorView

Returns formatter associated with this view, if any.

Specified by:

getFormater in interface MonitorView

Returns:

Formatter associated with this view, or null if there is no formatter.

setFormatter

public void setFormatter(MonitorFormat formatter)

Description copied from interface: MonitorView

Associates a formatter with this view. The exact way the formatter is used - if at all - depends on specific implementation.

Specified by:

setFormatter in interface MonitorView

Parameters:

formatter - Formatter to be associated with this view.

getGroupFields

public List<MonitorField> getGroupFields()

Retrieves a list MonitorField for display channel groups from the filter. The default implementation calls getFilter().getGroupFields(true) and then applies stringToField(...).

Returns:

List of fields for display channel groups, or null if the filter does not provide the list.

getDescriptor

public abstract AbstractMonitorView.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 AbstractMonitorView.Descriptor save()

Description copied from interface: Persistable

Returns JavaBean describing the current state of this component. The default implementation returns a clone of getDescriptor().

Specified by:

save in interface Persistable

Specified by:

save in interface Savable

Returns:

JavaBean encapsulating the state, or null if no state information needs to be saved.