org.lsst.ccs.gconsole.base.filter

Class Configuration

java.lang.Object

org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

org.lsst.ccs.gconsole.base.filter.Configuration

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class Configuration
extends AbstractChannelsFilter

Filter that selects subsystem state channels.

Author:

onoprien

Nested Class Summary

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

AgentChannelsFilter.Event, AgentChannelsFilter.Listener

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.services.persist.Persistable

Persistable.Descriptor

Field Summary

Fields inherited from class org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

descriptor

Fields inherited from interface org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter

ALL, CATEGORY

Constructor Summary

Constructors

Constructor and Description
Configuration(String name, List<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>	getDisplayPaths(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 org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

addListener, getDescriptor, 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.base.filter.PersistableAgentChannelsFilter

getUnfiltered

Methods inherited from interface org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter

getAttributes, getDisplayChannels, getDisplayPath, getDisplayPath, getDisplayPath, getDisplayPaths, getFields, getOriginPaths, isSelector, matchTemplate

Methods inherited from interface org.lsst.ccs.gconsole.services.persist.Persistable

edit, getCategory, getPath, restore, restore, save

Constructor Detail

Configuration

@Create(category="AgentChannelsFilter",
        name="Configuration",
        path="Built-In/Configuration",
        description="Channels filter that selects subsystem configuration channels.")
public Configuration(@Par(def="Configuration",desc="Filter name.")
                                                                                                                                                                                                                        String name,
                                                                                                                                                                                                                        @Par(def="_null_",desc="List of subsystems accepted by this filter. If null, all subsystems are accepted.")
                                                                                                                                                                                                                        List<String> agents)

Method Detail

getDisplayPaths

public List<String> getDisplayPaths(String originPath)

Description copied from interface: AgentChannelsFilter

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

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

The default implementation returns a singleton list that contains a string returned by AgentChannelsFilter.getDisplayPath(String) method.

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. If multiple original paths are mapped to the specified display path, this method may return one of them, or null.

The default implementation returns the display path provided as an argument.

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.

The default implementation returns null.

Returns:

Original channel paths accepted by this filter, or null if any original path for which AgentChannelsFilter.getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.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.

The default implementation returns null.

Returns:

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

getName

public String getName()

Description copied from interface: PersistableAgentChannelsFilter

Returns the name of this filter. The default implementation forwards the call to Persistable's descriptor.

Returns:

Name of this filter, or null if this filter has no name.