org.lsst.ccs.gconsole.base.filter

Class RegExRenamingFilter

java.lang.Object

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

org.lsst.ccs.gconsole.base.filter.RegExRenamingFilter

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class RegExRenamingFilter
extends AbstractChannelsFilter

Regular expression based channels filter. The filter selects channels that match a regular expression and maps them to display paths based on a template.

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
RegExRenamingFilter(String name, String regex, boolean wholePath, String displayPath, List<String> subsystems)

Method Summary

Modifier and Type	Method and Description
List<String>	getAgents() Returns a list of agent names accepted by this filter.
String	getDisplayPath(String originPath) Returns the display channel corresponding to the specified original path.
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.
static void	main(String... args)

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

getDisplayChannels, getDisplayPath, getDisplayPath, getDisplayPaths, getDisplayPaths, getFields, getGroups, 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

RegExRenamingFilter

@Create(category="AgentChannelsFilter",
        name="Regular expression filter",
        path="Built-In/Basic/Regular Expression, Renaming",
        description="Channels filter that uses a regular expression to select channels and leaves their paths unchanged.")
public RegExRenamingFilter(@Par(def="RegEx",desc="Filter name.")
                                                                                                                                                                                                                                                                                                    String name,
                                                                                                                                                                                                                                                                                                    @Par(desc="Regular expression to be applied to the channel path.")
                                                                                                                                                                                                                                                                                                    String regex,
                                                                                                                                                                                                                                                                                                    @Par(def="true",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,
                                                                                                                                                                                                                                                                                                    @Par(def="_null_",desc="Display path template. Each occurrence of ${name} or $g will be replaced by the result of evaluating the corresponding group(name) or group(g) from the regular expression match. If null, the original path will be used as the display path.")
                                                                                                                                                                                                                                                                                                    String displayPath,
                                                                                                                                                                                                                                                                                                    @Par(def="_null_",desc="List of accepted subsystem names. If null, channels from all subsystems can be accepted.")
                                                                                                                                                                                                                                                                                                    List<String> subsystems)

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.

getAgents

public List<String> getAgents()

Description copied from interface: AgentChannelsFilter

Returns a list of agent names accepted by this filter. The list returned by this method affects interpretation of channel selectors returned by getOriginChannels(): every selector that does not explicitly specify agent is only applied to agents from the list.

The default implementation returns null.

Returns:

Agent names accepted by this filter, or null if any agent is accepted.

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.

getDisplayPath

public String getDisplayPath(String originPath)

Description copied from interface: AgentChannelsFilter

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.

getOriginPath

public String getOriginPath(String displayPath)

Description copied from interface: AgentChannelsFilter

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.

main

public static void main(String... args)