org.lsst.ccs.subsystem.common.ui.focalplane.filter

Class FocalPlaneFilter

java.lang.Object

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

org.lsst.ccs.subsystem.common.ui.focalplane.filter.FocalPlaneFilter

All Implemented Interfaces:

org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter, org.lsst.ccs.gconsole.base.filter.PersistableAgentChannelsFilter, org.lsst.ccs.gconsole.services.persist.Persistable, org.lsst.ccs.gconsole.services.persist.Savable

Direct Known Subclasses:

DemoFocalPlaneFilter, GroupAttributeFilter, GroupingTemplateFilter

public abstract class FocalPlaneFilter
extends org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

Base class for channels filters used with focal plane views.

FocalPlaneFilter selects some of the data channels associated with particular focal plane segments, and splits them into one or more groups. The number of groups should be small enough for monitoring views to conveniently display (typically 10 or less). Some views treat groups as columns in a table, others provide combo boxes for the user to select the group to be displayed.

Filters extending this class specify (possibly many-to-many) mappings between original published data channels and display paths in the
RXX[[/RebX][/SXX[/SegmentXX]]]/GroupName
format.

This class conforms to the general AgentChannelsFilter contract, so its subclasses can be used as general purpose filters by any tool. It also provides two additional public methods - getGroups() and #getGroupFields(), focal plane specific default implementations for several methods, and utility methods intended to simplify implementing concrete subclasses.

To be useful, subclasses should implement at least one method - getDisplayPaths(channel) - either directly or by overriding one of the methods its default implementation uses: getDisplayPath(channel) or getDisplayPath(originalPath).

Segment class provides static utility methods that can be useful for implementing focal plane filters.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FocalPlaneFilter.Descriptor

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

org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter.Event, org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY Persistable category for focal plane filters.

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

descriptor

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

ALL

Constructor Summary

Constructors

Constructor and Description
FocalPlaneFilter()

Method Summary

Modifier and Type	Method and Description
List<String>	getAgents() Returns a list of subsystem names accepted by this filter, or null if any subsystem might be accepted.
FocalPlaneFilter.Descriptor	getDescriptor()
String	getDisplayPath(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel) Returns the display channel corresponding to the specified original channel.
protected String	getDisplayPath(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel, String group)
String	getDisplayPath(String originPath) Returns the display channel corresponding to the specified original path.
List<String>	getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel) Returns a list of display channels for the specified original channel.
protected List<String>	getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel, List<String> groups)
List<String>	getGroups() Returns a list of groups generated by 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.
List<String>	getOriginPaths(String displayPath) Returns the list of original paths mapped to the specified display channel.
FocalPlaneFilter.Descriptor	save()

Methods inherited from class org.lsst.ccs.gconsole.base.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.base.filter.PersistableAgentChannelsFilter

getName, getUnfiltered

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

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

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

edit, getCategory, restore, restore

Field Detail

CATEGORY

public static final String CATEGORY

Persistable category for focal plane filters.

See Also:

Constant Field Values

Constructor Detail

FocalPlaneFilter

public FocalPlaneFilter()

Method Detail

getAgents

public List<String> getAgents()

Returns a list of subsystem names accepted by this filter, or null if any subsystem might be accepted.

The implementation provided by this class returns null.

Returns:

Names of accepted agents.

getOriginChannels

public List<String> getOriginChannels()

Returns a list of original channel paths accepted by this filter. The list may contain templates and selectors. See AgentStatusAggregator.addListener(listener, agents, channels) for details.

The implementation provided by this class returns a singleton list that contains a selector for channels that have RAFT ID attribute.

Returns:

Original channel paths accepted by this filter, or null if any original path for which getDisplayPaths(channel) returns a non-empty list is accepted.

getOriginPath

public String getOriginPath(String displayPath)

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.

None of the currently known focal plane views call this method directly. However, it is called by getOriginPaths(displayPath) implementation unless the latter is overridden.

The implementation provided by this class returns null.

Parameters:

displayPath - Display channel path.

Returns:

Original path, or null if the specified path does not correspond to any original channel.

getOriginPaths

public List<String> getOriginPaths(String displayPath)

Returns the list of original paths mapped to the specified display channel.

The implementation provided by this class returns a list that contains one element - the path returned by getOriginPath(...) - or an empty list if getOriginPath(...) returns null.

Parameters:

displayPath - Display channel path.

Returns:

Original path, or an empty list if the specified path does not correspond to any original channel.

getDisplayPath

public String getDisplayPath(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel)

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

None of the currently known focal plane views call this method directly. However, it is called by getDisplayPaths(channel) implementation unless the latter is overridden.

The implementation provided by this class forwards the call to getDisplayPath(String) method.

Parameters:

channel - Original data channel.

Returns:

List of display channels.

getDisplayPath

public String getDisplayPath(String originPath)

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.

None of the currently known focal plane views call this method directly. However, it is called by getDisplayPath(channel) implementation unless the latter is overridden.

The implementation provided by this class returns null.

Parameters:

originPath - Original path.

Returns:

List of display channels.

getDisplayPaths

public List<String> getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel)

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

Note that if getOriginChannels() method returns a non-null list and that list does not contain the path of the specified original channel, most views will not display it.

The implementation provided by this class returns a list that contains one element - the path returned by getDisplayPath(channel) - or an empty list if getDisplayPath(channel) returns null.

Parameters:

channel - Original data channel.

Returns:

List of display channels.

getGroups

public List<String> getGroups()

Returns a list of groups generated by this filter.

The implementation provided by this class returns null.

Returns:

Group names, or null if this filter does not provide an explicit list of groups.

getDisplayPaths

protected List<String> getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel,
                                       List<String> groups)

getDisplayPath

protected String getDisplayPath(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel,
                                String group)

getDescriptor

public FocalPlaneFilter.Descriptor getDescriptor()

Specified by:

getDescriptor in interface org.lsst.ccs.gconsole.services.persist.Persistable

Overrides:

getDescriptor in class org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

save

public FocalPlaneFilter.Descriptor save()