org.lsst.ccs.gconsole.base.filter

Class PageFilter

java.lang.Object

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

org.lsst.ccs.gconsole.base.filter.PageFilter

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class PageFilter
extends AbstractChannelsFilter

Filter to be associated with a view that handles a single page of a multi-page parent view. // FIXME: Only used by deprecated TabbedView. Will be removed in future releases.

Author:

onoprien

Nested Class Summary

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

Persistable.Descriptor

Field Summary

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
PageFilter(AgentChannelsFilter filter, String page)

Method Summary

Modifier and Type	Method and Description
List<String>	getAgents() Returns a list of agent names accepted by this filter.
List<String>	getDisplayChannels() Returns a list of display paths produced by this filter.
List<String>	getDisplayPaths(AgentChannel channel) Returns a list of display channels for the specified original channel.
List<String>	getDisplayPaths(String originPath) Returns a list of display channels for the specified original path.
List<String>	getFields(boolean compact) Returns a list of attributes to display for each channel.
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.

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

getDisplayPath, getDisplayPath, getDisplayPath, getGroups, getOriginPaths, isSelector, matchTemplate

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

edit, getCategory, getPath, restore, restore, save

Constructor Detail

PageFilter

public PageFilter(AgentChannelsFilter filter,
                  String page)

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.

getDisplayChannels

public List<String> getDisplayChannels()

Description copied from interface: AgentChannelsFilter

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 actually available. If this method returns null, all display paths produced by getDisplayPaths(AgentChannel channel) for original channels accepted by getOriginChannels() should be displayed.

The default implementation returns null.

Returns:

Display paths produced by this filter, or null if the set of display paths is not constrained by this filter.

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.

getDisplayPaths

public List<String> getDisplayPaths(AgentChannel channel)

Description copied from interface: AgentChannelsFilter

Returns a list of display channels for the specified original channel. This method is called by clients that have access to original AgentChannel instances (like monitoring views).

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 AgentChannelsFilter.getDisplayPath(AgentChannel) method.

Parameters:

channel - Original data channel.

Returns:

List of display channels.

getDisplayPaths

public List<String> getDisplayPaths(String originPath)

Description copied from interface: AgentChannelsFilter

Returns a list of display channels for the specified original path. This method is called by clients that do not have access to original AgentChannel instances (like the trending tool).

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 AgentChannelsFilter.getDisplayPath(String) method.

Parameters:

originPath - Original path.

Returns:

List of display channels.

getFields

public List<String> getFields(boolean compact)

Description copied from interface: AgentChannelsFilter

Returns a list of attributes to display for each channel. The default implementation returns null.

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.