public class GenericFilter extends AbstractChannelsFilter
AgentChannelsFilter that mirrors parameters of AgentStatusAggregator.Persistable.Descriptor| Modifier and Type | Field and Description |
|---|---|
static String |
CREATOR_PATH |
static String |
CREATOR_PATH_MONITOR |
ALL, CREATOR_PATH_UNFILTERED, descriptorCATEGORY| Constructor and Description |
|---|
GenericFilter(String name,
List<String> agents,
List<String> channels,
String delimeter,
boolean separatePagesForAgents,
List<String> fields)
Constructs a filter.
|
GenericFilter(String name,
String agents,
String channels,
String delimeter,
boolean separatePagesForAgents,
String fields)
Constructs a filter, using comma-separated strings instead of lists.
|
| Modifier and Type | Method and Description |
|---|---|
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 selectors that might be accepted by this filter.
|
String |
getOriginPath(String displayPath)
Returns the original path corresponding to the specified display channel.
|
getDescriptor, getUnfilteredclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDisplayChannels, getDisplayPath, getDisplayPath, getDisplayPaths, getDisplayPaths, getGroups, getOriginPaths, isSelector, matchTemplateedit, getCategory, getPath, restore, restore, savepublic static final String CREATOR_PATH
public static final String CREATOR_PATH_MONITOR
@Create(category="AgentChannelsFilter", name="Configurable generic filter", path="Built-In/Basic/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 GenericFilter(@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)
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.public GenericFilter(String name, String agents, String channels, String delimeter, boolean separatePagesForAgents, String fields)
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.public String getDisplayPath(String originPath)
AgentChannelsFilternull.
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.
originPath - Original path.public String getOriginPath(String displayPath)
AgentChannelsFilternull.
The default implementation returns the display path provided as an argument.
displayPath - Display channel path.null if the specified path does not correspond to any original channel.public List<String> getOriginChannels()
AgentChannelsFilter
The list returned by this method may contain channel selectors of
several types (note that interpretation of some selectors depends on the
list returned by getAgents() method):
[agent]/[partial path][/]" format.
Templates that omit the agent name are expanded against all agents whose
names are in the getAgents() list (or all agents present on the
buses if that list is null). Templates that end with "/" match
all channels that start with "agent/partial path/".
[agent.name=value&][agent.type=value&][agent.key[=value]&…&agent.key[=value]&][key[=value]&…&key[=value]]"
format, where key and value are names and values of agent
properties or static channel attributes. If value is omitted, the
existence of the attribute is checked.
The default implementation returns null.
null if any
original path for which AgentChannelsFilter.getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel) returns a non-empty list is accepted.public List<String> getAgents()
AgentChannelsFiltergetOriginChannels(): every selector that does not explicitly specify agent is
only applied to agents from the list.
The default implementation returns null.
null if any agent is accepted.public String getName()
PersistableAgentChannelsFilternull if this filter has no name.public List<String> getFields(boolean compact)
AgentChannelsFilternull.compact - If true, returns a list of columns in a compact view.null if this filter does not provides any hints on what attributes should be displayed.@Create(category="AgentChannelsFilter", name="Monitor channels", path="Built-In/Basic/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)
Copyright © 2023 LSST. All rights reserved.