org.lsst.ccs.gconsole.base.filter

Class KeyDataAllSubsystemsFilter

java.lang.Object

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

org.lsst.ccs.gconsole.base.filter.KeyDataAllSubsystemsFilter

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class KeyDataAllSubsystemsFilter
extends AbstractChannelsFilter

Demo filter that selects key data from subsystems for displaying in a GroupView.

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
KeyDataAllSubsystemsFilter()

Method Summary

Modifier and Type	Method and Description
List<String>	getDisplayPaths(AgentChannel channel) Returns a list of display channels for the specified original channel.
List<String>	getFields(boolean compact) Returns a list of attributes to display for each channel.
String	getName() Returns the name of this filter.

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

getAgents, getDisplayChannels, getDisplayPath, getDisplayPath, getDisplayPath, getDisplayPaths, getGroups, getOriginChannels, getOriginPath, 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

KeyDataAllSubsystemsFilter

@Create(category="AgentChannelsFilter",
        name="Subsystems",
        path="Built-In/Whole Camera/Subsystems",
        description="Key data for all subsystems.")
public KeyDataAllSubsystemsFilter()

Method Detail

getDisplayPaths

public List<String> getDisplayPaths(AgentChannel channel)

Description copied from interface: AgentChannelsFilter

Returns a list of display channels for the specified original channel. This method is called by clients that have access to original AgentChannel instances (like monitoring views).

Not that 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 a singleton list that contains a string returned by AgentChannelsFilter.getDisplayPath(AgentChannel) method.

Parameters:

channel - Original data channel.

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.

getFields

public List<String> getFields(boolean compact)

Description copied from interface: AgentChannelsFilter

Returns a list of attributes to display for each channel. The default implementation returns null.

Parameters:

compact - If true, returns a list of columns in a compact view.

Returns:

Display fields, or null if this filter does not provides any hints on what attributes should be displayed.