Package org.lsst.ccs.gconsole.plugins.monitor

The CCS graphical console plugin and infrastructure classes that support displaying monitoring data.

See: Description

Interface Summary

Interface	Description
ChannelHandle	Data channel handle used by monitoring data views.
ImageView.MListener
MonitorTable.Listener
MonitorView	View of monitoring data.
MonitorView.Descriptor	JavaBean that contains information required to re-create this view in its current state.
Updatable	Implemented by software components whose states should be updated in response to changes in data channels.

Class Summary

Class	Description
AbstractMonitorView1	Adapter class that simplifies implementing monitor views.
AbstractMonitorView1.Descriptor	JavaBean that contains information required to re-create this view in its current state.
AbstractMonitorView2	Adapter class that simplifies implementing monitor views.
CellTableView	Monitoring data table to be displayed as a part of an ImageView.
CellView
CompoundView	A monitoring data view that manages several child views.
CompoundView.Descriptor	JavaBean that contains information required to re-create this view in its current state.
ConfigView	Monitoring data view that displays basic info for the monitored subsystems and provides monitoring controls.
DefaultChannelHandle	Default implementation of ChannelHandle.
DefaultView	Default MonitorView.
FormattedValue	Formatted content of a graphic component that displays a single value.
ImageView	Image-based MonitorView.
ImageView.Item
ImageView.MEvent
LsstMonitorPlugin	Graphical console plugin that supports display of monitoring data.
LsstMonitorPlugin.Descriptor
MeshTable	MonitorTable that displays channel values in a 2D grid.
MonitorCell	Data model for a graphical component that displays a single monitored value.
MonitorField	Descriptor of a field that can be displayed by monitoring views.
MonitorField.Average
MonitorFormat	Formatter for monitoring data.
MonitorFormat.DefaultMonitorFormat
MonitorTable	Skeleton implementation of a table that displays monitored values, and its model.
MonitorTable.Event
MonitorTableCellRenderer	Renderer for monitoring data table cells.
SectionedTable
SectionedTable.Descriptor
SectionedTableView	MonitorView that displays data channels in a table.
SectionedTableView.Descriptor
TabbedView	Monitoring view that displays several other views in tabs.
TabbedView.Descriptor	JavaBean that contains information required to re-create this view in its current state.
TreeTable	Table of monitoring data that uses a tree with collapsible nodes to display channel names.
TreeTableView	MonitorView that displays data channels in a single table with the name column rendered as a tree.
TreeView	MonitorView that displays monitoring data as a tree of tables.
TreeView.Descriptor	JavaBean that contains information required to re-create this view in its current state.
TreeView.InterNodeDescriptor

Enum Summary

Enum	Description
CompoundView.Mode	Enumeration of management modes for child views.
MonitorTable.Event.Reason
TreeView.InterNodeDescriptor.DisplayMode
TreeView.InterNodeDescriptor.Sort	Enumeration of sorting algorithms supported by InterNode.

Package org.lsst.ccs.gconsole.plugins.monitor Description

The CCS graphical console plugin and infrastructure classes that support displaying monitoring data.

Monitoring GUI framework

LsstMonitorPlugin enables menus and provides methods for opening new monitoring view, exporting their content into files, saving and restoring its state.

MonitorView is the interface to be implemented by any software component that needs to manage a graphical console page displaying monitoring data. It registers itself with the AgentStatusAggregator and updates in response to status change events. A view has an AgentChannelsFilter associated with it.

AbstractMonitorView1 is the first level adapter designed to simplify implementing MonitorView. It provides machinery for listening to status aggregator events and allows the developer to update the view by implementing responses to addition, removal, and modification of data channels. Channels are added along with the display path string as defined by the filter associated with the view. The same channel might be added multiple times with different paths.

AbstractMonitorView2 is the second level adapter built on top of AbstractMonitorView1. It wraps each added channel into ChannelHandle and maintains a map of display paths to channel handles. For minimal functionality, the developer only needs to implement a single method (resetChannels()) that rebuilds the view based on that map whenever channels are added or removed. The view is updated automatically as long as the correct Updatable is set for each ChannelHandle.

The package contains several concrete views - TreeView, SectionedTableView, ConfigView - as well as two utility views designed to combine several concrete views into a single view that can be managed by the graphical console: TabbedView and CompoundView.

The base class for most monitoring tables used by various views is MonitorTable. This class implements a table model as a 2-dimensional list of MonitorCell, handles mouse events, and provides a basic implementation of the Updatable interface. MonitorTableCellRenderer class provides the default renderer for FormattedValue. Several concrete subclasses of the MonitorTable are available for use in views: SectionedTable, MeshTable, TreeTable.

Formatting of table cells is done by MonitorFormat. It can be subclassed to customize formatting.