org.lsst.ccs.gconsole.agent.filter

Class States

java.lang.Object

org.lsst.ccs.gconsole.agent.filter.States

All Implemented Interfaces:

AgentChannelsFilter

@ConsoleLookup(id="org.lsst.ccs.gconsole.agent.AgentChannelsFilter",
               name="States",
               path="Built-In/States",
               description="Channels filter that selects subsystem state channels.<p><b>Optional parameters:</b><dl><dt>agents</dt><dd>Comma-separated list of subsystems accepted by this filter.</dd></dl>")
public class States
extends Object
implements AgentChannelsFilter

Filter that selects subsystem state channels.

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
States(String agents)

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.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addListener, getAttributes, getDisplayChannels, getDisplayPath, getFields, removeListener

Constructor Detail

States

public States(String agents)

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.

Specified by:

getDisplayPath in interface AgentChannelsFilter

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.

Specified by:

getOriginPath in interface AgentChannelsFilter

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.

Specified by:

getOriginChannels in interface AgentChannelsFilter

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.

Specified by:

getAgents in interface AgentChannelsFilter

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.

Specified by:

getName in interface AgentChannelsFilter

Returns:

Name of this filter.