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

Class GroupingTemplateFilter

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

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 GroupingTemplateFilter
extends FocalPlaneFilter

Focal plane specific template based filter that puts accepted channels into groups, each corresponding to a single display path.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupingTemplateFilter.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	PATH

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
GroupingTemplateFilter(GroupingTemplateFilter.Descriptor desc)

Method Summary

Modifier and Type	Method and Description
static GroupingTemplateFilter	create()
GroupingTemplateFilter	edit(String title, Component parent)
List<String>	getAgents() Returns a list of subsystem names accepted by this filter, or null if any subsystem might be accepted.
GroupingTemplateFilter.Descriptor	getDescriptor()
List<String>	getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel) Returns a list of display channels for the specified original channel.
List<String>	getDisplayPaths(String originPath)
List<String>	getFields(boolean compact)
String	getName()
List<String>	getOriginPaths(String displayPath) Returns the list of original paths mapped to the specified display channel.
GroupingTemplateFilter.Descriptor	save()

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

getDisplayPath, getDisplayPath, getDisplayPath, getDisplayPaths, getGroups, getOriginChannels, getOriginPath

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, isSelector, matchTemplate

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

getCategory, restore, restore

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

GroupingTemplateFilter

public GroupingTemplateFilter(GroupingTemplateFilter.Descriptor desc)

Method Detail

create

@Create(category="FocalPlaneFilter",
        name="Template Groups",
        path="Built-In/Template",
        description="Channels filter that maps groups of focal plane channels to display paths based on path templates.")
public static GroupingTemplateFilter create()

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.

getOriginPaths

public List<String> getOriginPaths(String displayPath)

Description copied from class: FocalPlaneFilter

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.

Specified by:

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

Overrides:

getOriginPaths in class FocalPlaneFilter

Parameters:

displayPath - Display channel path.

Returns:

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

getDisplayPaths

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

Description copied from class: FocalPlaneFilter

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

Note that if FocalPlaneFilter.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.

Specified by:

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

Overrides:

getDisplayPaths in class FocalPlaneFilter

Parameters:

channel - Original data channel.

Returns:

List of display channels.

getDisplayPaths

public List<String> getDisplayPaths(String originPath)

getFields

public List<String> getFields(boolean compact)

getDescriptor

public GroupingTemplateFilter.Descriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class FocalPlaneFilter

save

public GroupingTemplateFilter.Descriptor save()

Specified by:

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

Specified by:

save in interface org.lsst.ccs.gconsole.services.persist.Savable

Overrides:

save in class FocalPlaneFilter

edit

public GroupingTemplateFilter edit(String title,
                                   Component parent)