org.lsst.ccs.gconsole.base.filter

Class SubsystemSelectorFilter

java.lang.Object

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

org.lsst.ccs.gconsole.base.filter.SubsystemSelectorFilter

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class SubsystemSelectorFilter
extends AbstractChannelsFilter

AbstractChannelsFilter that selects channels from the specified subsystem. Strips the subsystem name, but leaves the channel path otherwise unchanged.

Author:

onoprien

Nested Class Summary

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

Persistable.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATOR_PATH

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

ALL, CREATOR_PATH_UNFILTERED, descriptor

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

CATEGORY

Constructor Summary

Constructors

Constructor and Description
SubsystemSelectorFilter(String subsystem)

Method Summary

Modifier and Type	Method and Description
List<String>	getAgents() Returns a list of agent names accepted by this filter.
String	getDisplayPath(String originPath) Returns the display channel corresponding to the specified original path.
String	getName() Returns the name of 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

getDescriptor, getUnfiltered

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

getDisplayChannels, getDisplayPath, getDisplayPath, getDisplayPaths, getDisplayPaths, getFields, getGroups, getOriginChannels, getOriginPaths, isSelector, matchTemplate

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

edit, getCategory, getPath, restore, restore, save

Field Detail

CREATOR_PATH

public static final String CREATOR_PATH

See Also:

Constant Field Values

Constructor Detail

SubsystemSelectorFilter

@Create(category="AgentChannelsFilter",
        name="Subsystem Selector",
        path="Built-In/Basic/Subsystem Selector",
        description="Selects channels from the specified subsystem only. Strips the subsystem name, but leaves the channel path otherwise unchanged.")
public SubsystemSelectorFilter(@Par(desc="Subsystem name.")
                                                                                                                                                                                                                                                                                                                   String subsystem)

Method Detail

getAgents

public List<String> getAgents()

Description copied from interface: AgentChannelsFilter

Returns a list of agent names accepted by this filter. The list returned by this method affects interpretation of channel selectors returned by getOriginChannels(): every selector that does not explicitly specify agent is only applied to agents from the list.

The default implementation returns null.

Returns:

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

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.

getDisplayPath

public String getDisplayPath(String originPath)

Description copied from interface: AgentChannelsFilter

Returns the display channel corresponding to the specified original path. If the original channel is mapped to multiple display paths, this method may return one of them, or null.

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 an unmodified original path.

Parameters:

originPath - Original path.

Returns:

List of display channels.

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.