org.lsst.ccs.gconsole.services.aggregator

Interface ChannelSelector

public interface ChannelSelector

Checks whether an AgentChannel satisfies certain criteria.

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 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(List<String> agents, List<ChannelSelector> channelSelectors, Collection<T> channels)
static <T extends AgentChannel> List<T>	filter(List<String> agents, List<ChannelSelector> channelSelectors, Collection<T> channels, List<T> out) Appends channels matching selectors to the provided list.
String	getAgent()
boolean	match(AgentChannel channel) Checks whether the specified channel 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.

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 -

channelSelectors -

channel - Channel to check.

Returns:

filter

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

filter

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

Appends channels matching 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()

match

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.