org.lsst.ccs.gconsole.plugins.monitor

Interface MonitorFilter

public interface MonitorFilter

A filter that defines content of one or more monitoring panels.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static MonitorFilter	PASS Trivial filter that accepts all channels and does not modify paths.

Method Summary

Modifier and Type	Method and Description
default Set<String>	getDisplayChannels() Returns a set of display paths produced by this filter.
default List<String>	getDisplayPath(String originPath) Returns a list of display channels for the specified original channel.
default String	getName(String displayPath) Returns the channel name for the specified display path.
default Set<String>	getOriginChannels() Returns a set of original channel paths accepted by this filter.
default String	getOriginPath(String displayPath) Returns the original path corresponding to the specified display channel.
default Set<String>	getSubsystems() Returns a set of subsystem names accepted by this filter.

Field Detail

PASS

static final MonitorFilter PASS

Trivial filter that accepts all channels and does not modify paths. This filter uses default implementations for all methods.

Method Detail

getSubsystems

default Set<String> getSubsystems()

Returns a set of subsystem names accepted by this filter.

Returns:

Subsystem names accepted by this filter, or null if any subsystem might be accepted.

getOriginChannels

default Set<String> getOriginChannels()

Returns a set of original channel paths accepted by this filter.

Returns:

Original channel paths accepted by this filter, or null if any original path for which getDisplayPath(java.lang.String) returns a non-empty list is accepted.

getDisplayChannels

default Set<String> getDisplayChannels()

Returns a set of display paths produced by this filter. Typically, if this method returns a non-null set, components downstream from this filter will display this fixed set of channels, whether or not the data is available, regardless of what paths are returned by getDisplayPath(java.lang.String) applied to accepted original channels. Otherwise, any display channels for which the data is available will be displayed.

Returns:

Display paths produced by this filter, or null if the set is not fixed.

getOriginPath

default String getOriginPath(String displayPath)

Returns the original path corresponding to the specified display channel.

Parameters:

displayPath - The display channel path.

Returns:

The original path, or null if the specified path does not correspond to any original channel.

getDisplayPath

default List<String> getDisplayPath(String originPath)

Returns a list of display channels for the specified original channel.

Parameters:

originPath - The path of the original channel.

Returns:

Display paths, or an empty list if the specified channel is not accepted by this filter.

getName

default String getName(String displayPath)

Returns the channel name for the specified display path.

Parameters:

displayPath - The display channel path.

Returns:

The name of the display channel, or null if the name is not specified by this filter.