public class TestFilter extends AbstractChannelsFilter
Persistable.DescriptorALL, CREATOR_PATH_UNFILTERED, descriptorCATEGORY| Constructor and Description |
|---|
TestFilter() |
| Modifier and Type | Method and Description |
|---|---|
List<String> |
getAgents()
Returns a list of agent names accepted by this filter.
|
List<String> |
getDisplayChannels()
Returns a list of display paths produced by this filter.
|
String |
getDisplayPath(AgentChannel channel)
Returns the display path corresponding to the specified original channel.
|
String |
getDisplayPath(String originPath)
Returns the display channel corresponding to the specified original path.
|
List<String> |
getDisplayPaths(AgentChannel channel)
Returns a list of display channels for the specified original channel.
|
List<String> |
getDisplayPaths(String originPath)
Returns a list of display channels for the specified original path.
|
List<String> |
getFields(boolean compact)
Returns a list of attributes to display for each channel.
|
List<String> |
getGroups()
Returns a list of groups of display paths produced by this filter.
|
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.
|
List<String> |
getOriginPaths(String displayPath)
Returns the list of original paths mapped to the specified display channel.
|
static PersistableAgentChannelsFilter |
getTest() |
getDescriptor, getUnfilteredclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDisplayPath, isSelector, matchTemplateedit, getCategory, getPath, restore, restore, savepublic static PersistableAgentChannelsFilter getTest()
public String getName()
PersistableAgentChannelsFilternull if this filter has no name.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 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> getDisplayChannels()
AgentChannelsFilternull list, components downstream from
this filter will display this fixed set of channels, whether or not the data is actually available.
If this method returns null, all display paths produced by getDisplayPaths(AgentChannel channel)
for original channels accepted by getOriginChannels() should be displayed.
The default implementation returns null.
null if the set of display
paths is not constrained by this filter.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.public List<String> getGroups()
AgentChannelsFilternull.null if the set of groups is not constrained by this filter.public List<String> getDisplayPaths(AgentChannel channel)
AgentChannelsFilterAgentChannel
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.
channel - Original data channel.public List<String> getDisplayPaths(String originPath)
AgentChannelsFilterAgentChannel
instances (like the trending tool).
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(String) method.
originPath - Original path.public String getDisplayPath(AgentChannel channel)
AgentChannelsFilternull if the clients that rely on mapping to a single
display path should ignore the specified channel.
The default implementation forwards the call to AgentChannelsFilter.getDisplayPath(String)
method. Subclasses may override it to take into account channel attributes and metadata.
channel - Original data channel.null if the provided channel is not accepted by this filter.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 List<String> getOriginPaths(String displayPath)
AgentChannelsFilter
The default implementation returns a list that contains one element - the
path returned by getOriginPath(...) - or an
empty list if getOriginPath(...) returns null.
displayPath - Display channel 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.Copyright © 2024 LSST. All rights reserved.