org.lsst.ccs.gconsole.plugins.demo.monitor

Class FilterFixed

java.lang.Object

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

org.lsst.ccs.gconsole.plugins.demo.monitor.FilterFixed

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class FilterFixed
extends AbstractChannelsFilter

Demo filter that displays a fixed set of channels from two different subsystems. The channels are shown on three pages, with some channels appearing on more than one page under different names. Any page hints from groovy description are ignored.

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
FilterFixed(String name, Map<String,String> displayToOriginPath)

Method Summary

Modifier and Type	Method and Description
List<String>	getAgents() Returns a list of agent names accepted by this filter.
List<String>	getDisplayChannels() Returns a list of display paths produced by this filter.
List<String>	getDisplayPaths(String originPath) Returns a list of display channels for the specified original path.
static FilterFixed	getInstance(int intParameter, String name, boolean boolParameter, org.lsst.ccs.bus.states.AlertState enumParameter) Demo for automatic filter instantiation.
String	getName() Returns the name of this filter.
String	getOriginPath(String displayPath) Returns the original path corresponding to the specified display channel.
static String	getPath()

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, getDisplayPath, getDisplayPath, getDisplayPath, getDisplayPaths, getFields, getOriginChannels, getOriginPaths, isSelector, matchTemplate

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

edit, getCategory, restore, restore, save

Constructor Detail

FilterFixed

public FilterFixed(String name,
                   Map<String,String> displayToOriginPath)

Method Detail

getInstance

public static FilterFixed getInstance(int intParameter,
                                      String name,
                                      boolean boolParameter,
                                      org.lsst.ccs.bus.states.AlertState enumParameter)

Demo for automatic filter instantiation.

Parameters:

intParameter - Integer parameter.

name - String parameter.

boolParameter - Boolean parameter.

enumParameter - Enum parameter.

Returns:

Created filter.

getPath

public static String getPath()

getName

public String getName()

Returns the name of this filter.

Returns:

Name of this filter.

getAgents

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

getDisplayChannels

public 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 getDisplayPaths(java.lang.String) 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

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

getDisplayPaths

public List<String> getDisplayPaths(String originPath)

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

Parameters:

originPath - Original path.

Returns:

List of display channels.