org.lsst.ccs.gconsole.agent.filter

Class GenericFilter

java.lang.Object

org.lsst.ccs.gconsole.agent.filter.AbstractChannelsFilter

org.lsst.ccs.gconsole.agent.filter.GenericFilter

All Implemented Interfaces:

AgentChannelsFilter

Direct Known Subclasses:

MonitorOnly

@ConsoleLookup(id="org.lsst.ccs.gconsole.agent.AgentChannelsFilter",
               name="Explicit Lists",
               path="Built-In/Generic",
               description="Channels filter that allows the user to specify lists of accepted agents and channels.<p><b>Optional parameters:</b><dl><dt>name</dt><dd>Filter name.</dd><dt>agents</dt><dd>Comma-separated list of subsystems accepted by this filter.</dd><dt>channels</dt><dd>Comma-separated list of channels accepted by this filter (may contain templates and selectors).</dd><dt>delimeter</dt><dd>Characters in the original channel path that should be replaced by a slash (and therefore used as a path delimeter). Enter literal string, or regular expression in double quotes.</dd><dt>separatePagesForAgents</dt><dd>If true, the subsystem name is used as a page name.</dd><dt>fields</dt><dd>Comma-separated list of fields to display. Available standard fields: VALUE, UNITS, LOW_ALARM, LOW_WARN, ALERT_LOW, HIGH_ALARM, HIGH_WARN, ALERT_HIGH, DESCR.Any attribute or metadata key may be used as well.</dd></dl>")
public class GenericFilter
extends AbstractChannelsFilter

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.agent.AgentChannelsFilter

AgentChannelsFilter.Event, AgentChannelsFilter.Listener

Field Summary

Fields inherited from interface org.lsst.ccs.gconsole.agent.AgentChannelsFilter

ALL

Constructor Summary

Constructors

Constructor and Description
GenericFilter(String name, String agents, String channels, String delimeter, boolean separatePagesForAgents, String fields) Constructs a filter.

Method Summary

Modifier and Type	Method and Description
List<String>	getAgents() Returns a list of agent names accepted by this filter.
List<String>	getDisplayPath(String originPath) Returns a list of display channels for the specified original path.
List<String>	getFields(boolean compact) Returns a list of attributes to display for each channel.
String	getName() Returns the name of this filter.
List<String>	getOriginChannels() Returns a list of original channel paths accepted by this filter.
String	getOriginPath(String displayPath) Returns the original path corresponding to the specified display channel.

Methods inherited from class org.lsst.ccs.gconsole.agent.filter.AbstractChannelsFilter

addListener, notifyListeners, removeListener

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.agent.AgentChannelsFilter

getAttributes, getDisplayChannels, getDisplayPath

Constructor Detail

GenericFilter

public GenericFilter(String name,
                     String agents,
                     String channels,
                     String delimeter,
                     boolean separatePagesForAgents,
                     String fields)

Constructs a filter.

Parameters:

name - Name of the filter.

agents - Comma-separated list of subsystems accepted by this filter.

channels - Comma-separated list of channels accepted by this filter (may contain templates and selectors).

delimeter - Character in the original channel path that should be replaced by a slash (and therefore used as a path delimeter).

separatePagesForAgents - If true, the subsystem name is used as a page name.

fields - Comma-separated list of fields to display.

Method Detail

getDisplayPath

public List<String> getDisplayPath(String originPath)

Description copied from interface: AgentChannelsFilter

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.

getOriginPath

public String getOriginPath(String displayPath)

Description copied from interface: AgentChannelsFilter

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.

getOriginChannels

public List<String> getOriginChannels()

Description copied from interface: AgentChannelsFilter

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 AgentChannelsFilter.getDisplayPath(org.lsst.ccs.gconsole.agent.AgentChannel) returns a non-empty list is accepted.

getAgents

public List<String> getAgents()

Description copied from interface: AgentChannelsFilter

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.

getName

public String getName()

Description copied from interface: AgentChannelsFilter

Returns the name of this filter.

Returns:

Name of this filter.

getFields

public List<String> getFields(boolean compact)

Description copied from interface: AgentChannelsFilter

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.