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

Class GroupAttributeFilter

java.lang.Object

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

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

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

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

public class GroupAttributeFilter
extends FocalPlaneFilter

Filter that puts channels into groups based on the value of the DATA_GROUP attribute.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupAttributeFilter.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 inherited from class org.lsst.ccs.subsystem.common.ui.focalplane.filter.FocalPlaneFilter

CATEGORY

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

ALL

Constructor Summary

Constructors

Constructor and Description
GroupAttributeFilter(GroupAttributeFilter.Descriptor desc)
GroupAttributeFilter(String subsystem)

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.
GroupAttributeFilter.Descriptor	getDescriptor()
String	getDisplayPath(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel) Returns the display channel corresponding to the specified original channel.
List<String>	getGroups() Returns a list of groups generated by this filter.
String	getName()

Methods inherited from class org.lsst.ccs.subsystem.common.ui.focalplane.filter.FocalPlaneFilter

getDisplayPath, getDisplayPath, getDisplayPaths, getDisplayPaths, getOriginChannels, getOriginPath, getOriginPaths, 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

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

Constructor Detail

GroupAttributeFilter

@Create(category="FocalPlaneFilter",
        name="Standard data groups",
        path="Built-In/Standard Groups/One Subsystem",
        description="Standard pre-defined focal plane data groups determined by the DATA_GROUP attribute.")
public GroupAttributeFilter(@Par(desc="Subsystem name.")
                                                                                                                                                                                                                                                                         String subsystem)

GroupAttributeFilter

public GroupAttributeFilter(GroupAttributeFilter.Descriptor desc)

Method Detail

getName

public String getName()

getAgents

public List<String> getAgents()

Description copied from class: FocalPlaneFilter

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.

Specified by:

getAgents in interface org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter

Overrides:

getAgents in class FocalPlaneFilter

Returns:

Names of accepted agents.

getDisplayPath

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

Description copied from class: FocalPlaneFilter

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 FocalPlaneFilter.getDisplayPath(String) method.

Specified by:

getDisplayPath in interface org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter

Overrides:

getDisplayPath in class FocalPlaneFilter

Parameters:

channel - Original data channel.

Returns:

List of display channels.

getGroups

public List<String> getGroups()

Description copied from class: FocalPlaneFilter

Returns a list of groups generated by this filter.

The implementation provided by this class returns null.

Overrides:

getGroups in class FocalPlaneFilter

Returns:

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

getDescriptor

public GroupAttributeFilter.Descriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class FocalPlaneFilter