org.lsst.ccs.gconsole.services.aggregator

Interface ChannelSelector

public interface ChannelSelector

Checks whether an AgentChannel satisfies certain criteria.

Selectors are created by calling one of the static compile(...) methods that convert string representation of selectors into instances of ChannelSelector. See AgentChannelsFilter for details on how string representations are interpreted.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static ChannelSelector	ALL Predefined selector that accepts all channels.
static Pattern	pRegEx

Method Summary

Modifier and Type	Method and Description
static boolean	accept(List<String> agents, List<ChannelSelector> channelSelectors, AgentChannel channel) Checks whether the specified channel is accepted by at least one of the provided selectors.
static boolean	accept(List<String> agents, List<ChannelSelector> channelSelectors, String originPath) Checks whether the specified channel is accepted by at least one of the provided selectors.
static List<ChannelSelector>	compile(Collection<String> rawSelectors) Constructs selectors from their string representations (in path, template, or selector format).
static ChannelSelector	compile(String rawSelector) Constructs a selector based on a string in path, template, or selector format.
static <T extends AgentChannel> List<T>	filter(AgentChannelsFilter filter, Collection<T> channels) Filters a list of channels, selecting those that might satisfy the provided filter, taking into account its List<String> getOriginChannels() and getAgents() methods.
static <T extends AgentChannel> List<T>	filter(List<String> agents, List<ChannelSelector> channelSelectors, Collection<T> channels) Filters list of channels, selecting those that match at least one of the selectors.
static <T extends AgentChannel> List<T>	filter(List<String> agents, List<ChannelSelector> channelSelectors, Collection<T> channels, List<T> out) Appends channels matching at least one of the selectors to the provided list.
static List<String>	filterPaths(AgentChannelsFilter filter, Collection<String> paths) Filters a list of original channel paths, selecting those that might satisfy the provided filter, taking into account its List<String> getOriginChannels() and getAgents() methods.
static List<String>	filterPaths(List<String> agents, List<ChannelSelector> channelSelectors, Collection<String> paths) Filters list of original channel paths, selecting those that match at least one of the selectors.
String	getAgent() Returns the name of the agent this selector is applicable to.
default boolean	match(AgentChannel channel) Checks whether the specified channel is accepted by this selector.
boolean	match(String originPath) Checks whether the specified channel path is accepted by this selector.

Field Detail

ALL

static final ChannelSelector ALL

Predefined selector that accepts all channels.

pRegEx

static final Pattern pRegEx

Method Detail

compile

static ChannelSelector compile(String rawSelector)

Constructs a selector based on a string in path, template, or selector format. See AgentStatusAggregator.addListener(...) for details.

Parameters:

rawSelector - String representation of selector.

Returns:

New instance of ChannelSelector, or null if the provided string is not a valid representation of a channel selector.

compile

static List<ChannelSelector> compile(Collection<String> rawSelectors)

Constructs selectors from their string representations (in path, template, or selector format). See AgentStatusAggregator.addListener(...) for details.

Parameters:

rawSelectors - String representations of selectors.

Returns:

New instances of ChannelSelector.

accept

static boolean accept(List<String> agents,
                      List<ChannelSelector> channelSelectors,
                      AgentChannel channel)

Checks whether the specified channel is accepted by at least one of the provided selectors.

Parameters:

agents - Acceptable agents (null means all) for selectors that do not explicitly specify agent (getAgent() method returns null).

channelSelectors - Selectors to try. If null, any channel that belongs to one of the specified agents is accepted.

channel - Channel to check.

Returns:

True if the specified channel is accepted by at least one of the provided selectors.

accept

static boolean accept(List<String> agents,
                      List<ChannelSelector> channelSelectors,
                      String originPath)

Checks whether the specified channel is accepted by at least one of the provided selectors.

Parameters:

agents - Acceptable agents (null means all) for selectors that do not explicitly specify agent (getAgent() method returns null).

channelSelectors - Selectors to try. If null, any channel that belongs to one of the specified agents is accepted.

originPath - Original channel path to check.

Returns:

True if the specified channel is accepted by at least one of the provided selectors.

filter

static <T extends AgentChannel> List<T> filter(List<String> agents,
                                               List<ChannelSelector> channelSelectors,
                                               Collection<T> channels)

Filters list of channels, selecting those that match at least one of the selectors.

Type Parameters:

T - AgentChannel type.

Parameters:

agents - Acceptable agents (null means all) for selectors that do not explicitly specify agent (getAgent() method returns null).

channelSelectors - Selectors to try. If null, any channel that belongs to one of the specified agents is accepted.

channels - List of candidate channels.

Returns:

List of accepted channels.

filter

static <T extends AgentChannel> List<T> filter(AgentChannelsFilter filter,
                                               Collection<T> channels)

Filters a list of channels, selecting those that might satisfy the provided filter, taking into account its List<String> getOriginChannels() and getAgents() methods.

Type Parameters:

T - AgentChannel type.

Parameters:

filter - Filter.

channels - List of candidate channels.

Returns:

List of accepted channels.

filterPaths

static List<String> filterPaths(List<String> agents,
                                List<ChannelSelector> channelSelectors,
                                Collection<String> paths)

Filters list of original channel paths, selecting those that match at least one of the selectors.

Parameters:

agents - Acceptable agents (null means all) for selectors that do not explicitly specify agent (getAgent() method returns null).

channelSelectors - Selectors to try. If null, any channel that belongs to one of the specified agents is accepted.

paths - List of candidate paths.

Returns:

List of accepted channels.

filterPaths

static List<String> filterPaths(AgentChannelsFilter filter,
                                Collection<String> paths)

Filters a list of original channel paths, selecting those that might satisfy the provided filter, taking into account its List<String> getOriginChannels() and getAgents() methods. Attribute selectors are ignored by this method.

Parameters:

filter - Filter.

paths - List of candidate paths.

Returns:

List of accepted channels.

filter

static <T extends AgentChannel> List<T> filter(List<String> agents,
                                               List<ChannelSelector> channelSelectors,
                                               Collection<T> channels,
                                               List<T> out)

Appends channels matching at least one of the selectors to the provided list. The input collection is assumed to contain channels from one agent.

Type Parameters:

T - Type of input and output lists, subclass of AgentChannel.

Parameters:

agents -

channelSelectors -

channels -

out -

Returns:

getAgent

String getAgent()

Returns the name of the agent this selector is applicable to.

Returns:

Agent name, or null if this selector might be applicable to multiple agents.

match

default boolean match(AgentChannel channel)

Checks whether the specified channel is accepted by this selector.

Parameters:

channel - Channel to check.

Returns:

true if the channel satisfies the criteria of this selector.

match

boolean match(String originPath)

Checks whether the specified channel path is accepted by this selector.

Parameters:

originPath - Original channel path to check.

Returns:

true if the channel satisfies the criteria of this selector.