org.lsst.ccs.gconsole.base.filter

Class GenericFilterPersistable

java.lang.Object

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

org.lsst.ccs.gconsole.base.filter.GenericFilterPersistable

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class GenericFilterPersistable
extends AbstractChannelsFilter

Generic configurable channel filter.

Author:

onoprien

Nested Class Summary

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

AgentChannelsFilter.Event, AgentChannelsFilter.Listener

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.services.persist.Persistable

Persistable.Descriptor

Field Summary

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
GenericFilterPersistable(String name, List<String> agents, List<String> channels, String delimeter, boolean separatePagesForAgents, List<String> fields) Constructs a filter.

Method Summary

Modifier and Type	Method and Description
static AgentChannelsFilter	agentSelector(String subsystem)
static AgentChannelsFilter	filterMonitorOnly(String name, List<String> agents, String delimeter, boolean separatePagesForAgents, List<String> fields)
List<String>	getAgents() Returns a list of agent names accepted by this filter.
String	getDisplayPath(String originPath) Returns the display channel corresponding to the specified original path.
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.
String	getOriginPath(String displayPath) Returns the original path corresponding to the specified display channel.

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

addListener, getDescriptor, 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, getDisplayPath, getDisplayPaths, getDisplayPaths, getOriginPaths, isSelector, matchTemplate

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

edit, getCategory, restore, restore, save

Constructor Detail

GenericFilterPersistable

@Create(category="AgentChannelsFilter",
        name="Configurable generic filter",
        path="Built-In/Generic",
        description="Channels filter that leaves paths unchanged (except for possibly replacing delimeters with slashes and inserting doupbe slashes to separate pages), but allows selecting desired subsystems, channels, and monitor fields.")
public GenericFilterPersistable(@Par(def="_null_",desc="Filter name. Optional.")
                                                                                                                                                                                                                                                                                                                                                                                                       String name,
                                                                                                                                                                                                                                                                                                                                                                                                       @Par(def="_null_",desc="List of subsystems accepted by this filter. If not specified, all subsystems are accepted.")
                                                                                                                                                                                                                                                                                                                                                                                                       List<String> agents,
                                                                                                                                                                                                                                                                                                                                                                                                       @Par(def="_null_",desc="List of channels accepted by this filter (may contain templates and selectors). If not specified, all subsystems are accepted.")
                                                                                                                                                                                                                                                                                                                                                                                                       List<String> channels,
                                                                                                                                                                                                                                                                                                                                                                                                       @Par(def="_null_",desc="Character in the original channel path that should be replaced by a slash (and therefore used as a path delimeter).")
                                                                                                                                                                                                                                                                                                                                                                                                       String delimeter,
                                                                                                                                                                                                                                                                                                                                                                                                       @Par(def="false",desc="If true, the first slash in the path is replaced by a double slash. This causes some monitoring views display each subsystem data in a separate tab.")
                                                                                                                                                                                                                                                                                                                                                                                                       boolean separatePagesForAgents,
                                                                                                                                                                                                                                                                                                                                                                                                       @Par(def="_null_",desc="List of fields to display in monitor views. If not specified, the default set of fields is displayed. The default depends on a specific view. Some views may ignore the list of fields suggested by the filter. Available standard fields: VALUE, UNITS, LOW_ALARM, LOW_WARN, ALERT_LOW, HIGH_ALARM, HIGH_WARN, ALERT_HIGH, DESCR.")
                                                                                                                                                                                                                                                                                                                                                                                                       List<String> fields)

Constructs a filter.

Parameters:

name - Name of the filter.

agents - Comma-separated list of subsystems accepted by this filter.

channels - Comma-separated list of channels accepted by this filter (may contain templates and selectors).

delimeter - Character in the original channel path that should be replaced by a slash (and therefore used as a path delimeter).

separatePagesForAgents - If true, the subsystem name is used as a page name.

fields - Comma-separated list of fields to display.

Method Detail

getDisplayPath

public String getDisplayPath(String originPath)

Description copied from interface: AgentChannelsFilter

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.

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 an unmodified original path.

Parameters:

originPath - Original path.

Returns:

List of display channels.

getOriginPath

public String getOriginPath(String displayPath)

Description copied from interface: AgentChannelsFilter

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.

The default implementation returns the display path provided as an argument.

Parameters:

displayPath - Display channel path.

Returns:

Original path, or null 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.

filterMonitorOnly

@Create(category="AgentChannelsFilter",
        name="Monitor channels",
        path="Built-In/Monitor",
        description="Channels filter that leaves paths unchanged (except for possibly replacing delimeters with slashes and inserting doupbe slashes to separate pages), but accepts only monitored channels.")
public static AgentChannelsFilter filterMonitorOnly(@Par(def="Monitored channels",desc="Filter name.")
                                                                                                                                                                                                                                                                                                                                                                              String name,
                                                                                                                                                                                                                                                                                                                                                                              @Par(def="_null_",desc="List of subsystems accepted by this filter. If not specified, all subsystems are accepted.")
                                                                                                                                                                                                                                                                                                                                                                              List<String> agents,
                                                                                                                                                                                                                                                                                                                                                                              @Par(def="_null_",desc="Character in the original channel path that should be replaced by a slash (and therefore used as a path delimeter).")
                                                                                                                                                                                                                                                                                                                                                                              String delimeter,
                                                                                                                                                                                                                                                                                                                                                                              @Par(def="false",desc="If true, the first slash in the path is replaced by a double slash. This causes some monitoring views display each subsystem data in a separate tab.")
                                                                                                                                                                                                                                                                                                                                                                              boolean separatePagesForAgents,
                                                                                                                                                                                                                                                                                                                                                                              @Par(def="_null_",desc="List of fields to display in monitor views. If not specified, the default set of fields is displayed. The default depends on a specific view. Some views may ignore the list of fields suggested by the filter.")
                                                                                                                                                                                                                                                                                                                                                                              List<String> fields)

agentSelector

@Create(category="AgentChannelsFilter",
        name="Subsystem Selector",
        path="Built-In/Subsystem Selector",
        description="Selects channels from the specified subsystem only. Leaves paths unchanged.")
public static AgentChannelsFilter agentSelector(@Par(desc="Subsystem name.")
                                                                                                                                                                                                                                                                          String subsystem)