AgentChannelsFilter (LSST CCS Graphical User Interface 3.3.3 API)

All Superinterfaces:

Savable

All Known Subinterfaces:

PersistableAgentChannelsFilter

All Known Implementing Classes:

AbstractChannelsFilter, CellTableView, CellView, Configuration, FilterFixed, FilterMonitored, FilterOutOfRange, GenericFilter, GenericFilterPersistable, MonitorOnly, PageFilter, RegExFilter, States
```
public interface AgentChannelsFilter
extends Savable
```
A filter that selects a set of data channels and defines their presentation. Original channels are identified by their unique string trending paths (slash-separated, the first segment is the subsystem name). This filter maps some of the original channels to one or more display paths in
[page//]path1/.../pathN/name format.
The exact interpretation of filter output depends on the tool using the filter. See AgentStatusAggregator#addListener(AgentStatusListener, AgentChannelsFilter) for more details on using filters to configure agent status aggregator and tools that rely on it.

Author:

onoprien

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`AgentChannelsFilter.Event`
`static interface`	`AgentChannelsFilter.Listener` Interface to be implemented by classes that should be notified of changes in the `AgentChannelsFilter`.

Field Summary

Fields
Modifier and Type	Field and Description
`static PersistableAgentChannelsFilter`	`ALL` Trivial filter that accepts all channels and does not modify paths.
`static String`	`CATEGORY` Category for general purpose `Persistable` filters.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addListener(AgentChannelsFilter.Listener listener)` Registers a listener that will be notified of any changes in this filter.
`default List<String>`	`getAgents()` Returns a list of agent names accepted by this filter.
`default Map<String,Object>`	`getAttributes(String path)` Returns additional attributes associated with the specified path.
`default List<String>`	`getDisplayChannels()` Returns a list of display paths produced by this filter.
`default String`	`getDisplayPath(AgentChannel channel)` Returns the display channel corresponding to the specified original channel.
`static List<String>`	`getDisplayPath(AgentChannelsFilter filter, String originPath)` Returns a list of display paths for the specified original path, applying the provided filter.
`default String`	`getDisplayPath(String originPath)` Returns the display channel corresponding to the specified original path.
`default List<String>`	`getDisplayPaths(AgentChannel channel)` Returns a list of display channels for the specified original channel.
`default List<String>`	`getDisplayPaths(String originPath)` Returns a list of display channels for the specified original path.
`default List<String>`	`getFields(boolean compact)` Returns a list of attributes to display for each channel.
`default String`	`getName()` Returns the name of this filter.
`default List<String>`	`getOriginChannels()` Returns a list of original channel paths accepted by this filter.
`default String`	`getOriginPath(String displayPath)` Returns the original path corresponding to the specified display channel.
`default List<String>`	`getOriginPaths(String displayPath)` Returns the list of original paths mapped to the specified display channel.
`static boolean`	`isSelector(String code)` Checks whether the specified string is in the channel selector format (as opposed to explicit path or template).
`static boolean`	`matchTemplate(String path, String template)` Checks whether the path matches the template.
`default void`	`removeListener(AgentChannelsFilter.Listener listener)` Removes a listener.

Methods inherited from interface org.lsst.ccs.gconsole.services.persist.Savable
restore, save

- Field Detail
  - CATEGORY
```
static final String CATEGORY
```
    Category for general purpose Persistable filters.
    
    See Also:
    
    Constant Field Values
  - ALL
```
static final PersistableAgentChannelsFilter ALL
```
    Trivial filter that accepts all channels and does not modify paths. This filter uses default implementations for all methods.
- Method Detail
  - getName
```
default String getName()
```
    Returns the name of this filter.
    The default implementation returns null.
    
    Returns:
    
    Name of this filter, or null if this filter has no name.
  - getAgents
```
default List<String> getAgents()
```
    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.
  - getOriginChannels
```
default List<String> getOriginChannels()
```
    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 getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel) returns a non-empty list is accepted.
  - getDisplayChannels
```
default List<String> getDisplayChannels()
```
    Returns a list of display paths produced by this filter. Typically, if this method returns a non-null list, components downstream from this filter will display this fixed set of channels, whether or not the data is available, regardless of what paths are returned by getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel) applied to accepted original channels. Otherwise, any display channels for which the data is available will be displayed.
    The default implementation returns null.
    
    Returns:
    
    Display paths produced by this filter, or null if the list is not fixed.
  - getOriginPath
```
default String getOriginPath(String displayPath)
```
    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.
  - getOriginPaths
```
default List<String> getOriginPaths(String displayPath)
```
    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.
  - getDisplayPath
```
default String getDisplayPath(AgentChannel channel)
```
    Returns the display channel corresponding to the specified original channel. If the original channel is mapped to multiple display paths, this method may return one of them, or null.
    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 forwards the call to getDisplayPath(String) method. Subclasses may override it to take into account channel attributes and metadata.
    
    Parameters:
    
    channel - Original data channel.
    
    Returns:
    
    List of display channels.
  - getDisplayPath
```
default String getDisplayPath(String originPath)
```
    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.
  - getDisplayPaths
```
default List<String> getDisplayPaths(AgentChannel channel)
```
    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 getDisplayPath(AgentChannel) method.
    
    Parameters:
    
    channel - Original data channel.
    
    Returns:
    
    List of display channels.
  - getDisplayPaths
```
default List<String> getDisplayPaths(String originPath)
```
    Returns a list of display channels for the specified original path.
    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 getDisplayPath(String) method.
    
    Parameters:
    
    originPath - Original path.
    
    Returns:
    
    List of display channels.
  - getAttributes
```
default Map<String,Object> getAttributes(String path)
```
    Returns additional attributes associated with the specified path.
    
    Parameters:
    
    path - Full or partial display path.
    
    Returns:
    
    Map of attribute names to their values.
  - getFields
```
default List<String> getFields(boolean compact)
```
    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.
  - addListener
```
default void addListener(AgentChannelsFilter.Listener listener)
```
    Registers a listener that will be notified of any changes in this filter.
    
    Parameters:
    
    listener - Listener to be notified.
  - removeListener
```
default void removeListener(AgentChannelsFilter.Listener listener)
```
    Removes a listener.
    
    Parameters:
    
    listener - Listener to be removed.
  - getDisplayPath
```
static List<String> getDisplayPath(AgentChannelsFilter filter,
                                   String originPath)
```
    Returns a list of display paths for the specified original path, applying the provided filter. This method takes into account the output of getDisplayPaths(originPath), getDisplayChannels(), and getOriginChannels(). Templates in the list of origin paths returned by the filter are honored by selectors are ignored.
    
    Parameters:
    
    filter - Filter to apply.
    
    originPath - Origin path.
    
    Returns:
    
    List of display path.
  - matchTemplate
```
static boolean matchTemplate(String path,
                             String template)
```
    Checks whether the path matches the template.
    
    Parameters:
    
    path - Origin path.
    
    template - Path template.
    
    Returns:
    
    True if the path matches.
  - isSelector
```
static boolean isSelector(String code)
```
    Checks whether the specified string is in the channel selector format (as opposed to explicit path or template).
    
    Parameters:
    
    code - String to test.
    
    Returns:
    
    true if the specified string is a channel selector.

Interface AgentChannelsFilter

Nested Class Summary

Field Summary

Method Summary

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

Field Detail

CATEGORY

ALL

Method Detail

getName

getAgents

getOriginChannels

getDisplayChannels

getOriginPath

getOriginPaths

getDisplayPath

getDisplayPath

getDisplayPaths

getDisplayPaths

getAttributes

getFields

addListener

removeListener

getDisplayPath

matchTemplate

isSelector