org.lsst.ccs.gconsole.agent

Interface AgentChannelsFilter

All Known Implementing Classes:

AbstractChannelsFilter, CellTableView, CellView, Configuration, FilterFixed, FilterMonitored, FilterOutOfRange, GenericFilter, MonitorOnly, PageFilter, States

public interface AgentChannelsFilter

A filter that selects a set of data channels and defines their presentation. Original channels are identified by their unique string trending paths (slash-separated, the first segment is the subsystem name). This filter maps some of the original channels to one or more display paths in "[page//]path1/.../pathN/name" format.

The exact interpretation of filter output depends on the tool using the filter. See AgentStatusAggregator.addListener(AgentStatusListener, AgentChannelsFilter) for more details on using filters to configure agent status aggregator and tools that rely on it.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AgentChannelsFilter.Event
static interface	AgentChannelsFilter.Listener Interface to be implemented by classes that should be notified of changes in the AgentChannelsFilter.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
default void	addListener(AgentChannelsFilter.Listener listener) Registers a listener that will be notified of any changes in this filter.
default List<String>	getAgents() Returns a list of agent names accepted by this filter.
default Map<String,Object>	getAttributes(String path) Returns additional attributes associated with the specified path.
default List<String>	getDisplayChannels() Returns a list of display paths produced by this filter.
default List<String>	getDisplayPath(AgentChannel channel) Returns a list of display channels for the specified original channel.
default List<String>	getDisplayPath(String originPath) Returns a list of display channels for the specified original path.
default List<String>	getFields(boolean compact) Returns a list of attributes to display for each channel.
default String	getName() Returns the name of this filter.
default List<String>	getOriginChannels() Returns a list of original channel paths accepted by this filter.
default String	getOriginPath(String displayPath) Returns the original path corresponding to the specified display channel.
default void	removeListener(AgentChannelsFilter.Listener listener) Removes a listener.

Field Detail

ALL

static final AgentChannelsFilter ALL

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

Method Detail

getName

default String getName()

Returns the name of this filter.

Returns:

Name of this filter.

getAgents

default List<String> getAgents()

Returns a list of agent names accepted by this filter.

Returns:

Agent names accepted by this filter, or null if any agent might be accepted.

getOriginChannels

default List<String> getOriginChannels()

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

Note that if this filter is used to configure AgentStatusAggregator or any clients that rely on it (like monitoring data views), the list returned by this method may contain templates and selectors. See AgentStatusAggregator.addListener(listener, agents, channels) for details.

Returns:

Original channel paths accepted by this filter, or null if any original path for which getDisplayPath(org.lsst.ccs.gconsole.agent.AgentChannel) returns a non-empty list is accepted.

getDisplayChannels

default List<String> getDisplayChannels()

Returns a list 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(org.lsst.ccs.gconsole.agent.AgentChannel) 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 - Display channel path.

Returns:

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

getDisplayPath

default List<String> getDisplayPath(AgentChannel channel)

Returns a list of display channels for the specified original channel. The default implementation forwards the call to getDisplayPath(String) method. Subclasses may override it to take into account channel attributes and metadata.

Not that if the specified original channel is not accepted by this filter, this method should return an empty list. null should never be returned.

Parameters:

channel - Original data channel.

Returns:

List of display channels.

getDisplayPath

default List<String> getDisplayPath(String originPath)

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

Not that if the specified original channel is not accepted by this filter, this method should return an empty list. null should never be returned.

Parameters:

originPath - Original path.

Returns:

List of display channels.

getAttributes

default Map<String,Object> getAttributes(String path)

Returns additional attributes associated with the specified path.

Parameters:

path - Full or partial display path.

Returns:

Map of attribute names to their values.

getFields

default List<String> getFields(boolean compact)

Returns a list of attributes to display for each channel.

Parameters:

compact - If true, returns a list of columns in a compact view.

Returns:

Display fields, or null if this filter does not provides any hints on what attributes should be displayed.

addListener

default void addListener(AgentChannelsFilter.Listener listener)

Registers a listener that will be notified of any changes in this filter.

Parameters:

listener - Listener to be notified.

removeListener

default void removeListener(AgentChannelsFilter.Listener listener)

Removes a listener.

Parameters:

listener - Listener to be removed.