org.lsst.ccs.gconsole.plugins.monitor

Interface MonitorView

All Superinterfaces:

AgentStatusListener

All Known Subinterfaces:

PersistableMonitorView

All Known Implementing Classes:

AbstractMonitorView, CellTableView, CellView, ComboGroupView, CompoundView, ConfigurationView, ConfigView, DefaultView, GroupView, ImageView, LazyTreeView, SectionedTableView, SummaryTableView, TabbedGroupView, TabbedView, TreeView

public interface MonitorView
extends AgentStatusListener

View of monitoring data.

AgentStatusListener methods are called on the AgentStatusAggregator thread. All other methods declared by this interface should be called on AWT Event Dispatch Thread.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY Category for general purpose Persistable views.

Method Summary

Modifier and Type	Method and Description
AgentChannelsFilter	getFilter() Returns the filter associated with this view, or null if there is none.
default MonitorFormat	getFormater() Returns formatter associated with this view, if any.
default String	getName() Returns the name of this view.
JComponent	getPanel() Returns the graphical component maintained by this view.
default void	install() Installs this view, connecting it to the data source.
default boolean	isEmpty() Returns true if this view has no content to display at the moment.
void	setFilter(AgentChannelsFilter filter) Sets the channels filter to be used by this view.
default void	setFormatter(MonitorFormat formatter) Associates a formatter with this view.
default void	setName(String name) Sets the name of this view.
default void	uninstall() Uninstalls this view, disconnecting it from the data source.

Methods inherited from interface org.lsst.ccs.gconsole.services.aggregator.AgentStatusListener

configure, connect, disconnect, statusChanged

Field Detail

CATEGORY

static final String CATEGORY

Category for general purpose Persistable views.

See Also:

Constant Field Values

Method Detail

getPanel

JComponent getPanel()

Returns the graphical component maintained by this view.

Returns:

Graphical component to be displayed by the GUI.

getName

default String getName()

Returns the name of this view.

Returns:

View name.

setName

default void setName(String name)

Sets the name of this view.

Parameters:

name - View name.

getFilter

AgentChannelsFilter getFilter()

Returns the filter associated with this view, or null if there is none.

Returns:

Channels filter.

setFilter

void setFilter(AgentChannelsFilter filter)

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.

Parameters:

filter - Filter to be associated with this view.

getFormater

default MonitorFormat getFormater()

Returns formatter associated with this view, if any.

Returns:

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

setFormatter

default void setFormatter(MonitorFormat formatter)

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

Parameters:

formatter - Formatter to be associated with this view.

isEmpty

default boolean isEmpty()

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.

install

default void install()

Installs this view, connecting it to the data source.

uninstall

default void uninstall()

Uninstalls this view, disconnecting it from the data source. Uninstalling a view that has not been installed should have no effect.