org.lsst.ccs.gconsole.base.filter

Class RegExFilter

java.lang.Object

org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

org.lsst.ccs.gconsole.base.filter.RegExFilter

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class RegExFilter
extends AbstractChannelsFilter

Regular expression based channels filter. The filter selects channels that match a regular expression and leaves the paths unchanged.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.services.persist.Persistable

Persistable.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATOR_PATH

Fields inherited from class org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

ALL, CREATOR_PATH_UNFILTERED, descriptor

Fields inherited from interface org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter

CATEGORY

Constructor Summary

Constructors

Constructor and Description
RegExFilter(String name, String regex, boolean wholePath)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

getDescriptor, getUnfiltered

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter

getAgents, getDisplayChannels, getDisplayPath, getDisplayPath, getDisplayPath, getDisplayPaths, getDisplayPaths, getFields, getGroups, getOriginPath, getOriginPaths, isSelector, matchTemplate

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

edit, getCategory, getPath, restore, restore, save

Field Detail

CREATOR_PATH

public static final String CREATOR_PATH

See Also:

Constant Field Values

Constructor Detail

RegExFilter

@Create(category="AgentChannelsFilter",
        name="Regular expression filter",
        path="Built-In/Basic/Regular Expression",
        description="Channels filter that uses a regular expression to select channels and leaves their paths unchanged.")
public RegExFilter(@Par(def="RegEx",desc="Filter name.")
                                                                                                                                                                                                                                                                                  String name,
                                                                                                                                                                                                                                                                                  @Par(desc="Regular expression to be applied to the channel path.")
                                                                                                                                                                                                                                                                                  String regex,
                                                                                                                                                                                                                                                                                  @Par(def="false",desc="Match the whole path. If checked, a channel is accepted only if the provided regular expression matches its entire path. Otherwise, a channel is accepted if the regular expression matches any part of the path.")
                                                                                                                                                                                                                                                                                  boolean wholePath)

Method Detail

getName

public String getName()

Description copied from interface: PersistableAgentChannelsFilter

Returns the name of this filter. The default implementation forwards the call to Persistable's descriptor.

Returns:

Name of this filter, or null if this filter has no name.

getOriginChannels

public List<String> getOriginChannels()

Description copied from interface: AgentChannelsFilter

Returns a list of original channel selectors that might be accepted by this filter.

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):

• Complete path.
• Path template in the "[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/".
• Arbitrary regular expression (to be matched against the entire original path).
• Attribute selector strings in the "[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.

Returns:

Original channel paths accepted by this filter, or null if any original path for which AgentChannelsFilter.getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel) returns a non-empty list is accepted.