org.lsst.ccs.gconsole.base.filter

Class CoreStates

java.lang.Object

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

org.lsst.ccs.gconsole.base.filter.CoreStates

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class CoreStates
extends AbstractChannelsFilter

Filter that selects subsystem state channels.

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 List<String>	CHANNELS

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
CoreStates(String name, List<String> agents)

Method Summary

Modifier and Type	Method and Description
List<String>	getAgents() Returns a list of agent names accepted by this filter.
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.
List<String>	getOriginChannels() Returns a list of original channel paths accepted by this filter.
List<String>	getOriginPaths(String displayPath) Returns the list of original paths mapped to the specified display channel.

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

getDescriptor

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, getDisplayPath, getDisplayPath, getDisplayPaths, getOriginPath, isSelector, matchTemplate

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

edit, getCategory, getPath, restore, restore, save

Field Detail

CHANNELS

public static List<String> CHANNELS

Constructor Detail

CoreStates

@Create(category="AgentChannelsFilter",
        name="Core States",
        path="Built-In/Core States",
        description="Selects core state channels, renames them to shorten the path.")
public CoreStates(@Par(def="Core states",desc="Filter name.")
                                                                                                                                                                                                                 String name,
                                                                                                                                                                                                                 @Par(def="_null_",desc="List of subsystems accepted by this filter. If null, all subsystems are accepted.")
                                                                                                                                                                                                                 List<String> agents)

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.

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.

getOriginPaths

public List<String> getOriginPaths(String displayPath)

Description copied from interface: AgentChannelsFilter

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

The default implementation 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 paths, or an empty list if the specified path does not correspond to any original channel.

getOriginChannels

public List<String> getOriginChannels()

Description copied from interface: AgentChannelsFilter

Returns a list of original channel paths accepted by this filter.

Note that if this filter is used to configure AgentStatusAggregator or any clients that rely on it (like monitoring data views), the list returned by this method may contain templates and selectors. See AgentStatusAggregator.addListener(listener, agents, channels) for details.

The default implementation returns null.

Returns:

Original channel paths accepted by this filter, or null if any original path for which AgentChannelsFilter.getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel) returns a non-empty list is accepted.

getAgents

public List<String> getAgents()

Description copied from interface: AgentChannelsFilter

Returns a list of agent names accepted by this filter.

The default implementation returns null.

Returns:

Agent names accepted by this filter, or null if any agent might be accepted.

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.

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.