org.lsst.ccs.gconsole.agent.filter

Class PageFilter

java.lang.Object

org.lsst.ccs.gconsole.agent.filter.PageFilter

All Implemented Interfaces:

AgentChannelsFilter

public class PageFilter
extends Object
implements AgentChannelsFilter

Filter to be associated with a view that handles a single page of a multi-page parent view.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.agent.AgentChannelsFilter

AgentChannelsFilter.Event, AgentChannelsFilter.Listener

Field Summary

Fields inherited from interface org.lsst.ccs.gconsole.agent.AgentChannelsFilter

ALL

Constructor Summary

Constructors

Constructor and Description
PageFilter(AgentChannelsFilter filter, String page)

Method Summary

Modifier and Type	Method and Description
void	addListener(AgentChannelsFilter.Listener listener) Registers a listener that will be notified of any changes in this filter.
List<String>	getAgents() Returns a list of agent names accepted by this filter.
Map<String,Object>	getAttributes(String path) Returns additional attributes associated with the specified path.
List<String>	getDisplayChannels() Returns a list of display paths produced by this filter.
List<String>	getDisplayPath(AgentChannel channel) Returns a list of display channels for the specified original channel.
List<String>	getDisplayPath(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 paths accepted by this filter.
String	getOriginPath(String displayPath) Returns the original path corresponding to the specified display channel.
void	removeListener(AgentChannelsFilter.Listener listener) Removes a listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageFilter

public PageFilter(AgentChannelsFilter filter,
                  String page)

Method Detail

getName

public String getName()

Description copied from interface: AgentChannelsFilter

Returns the name of this filter.

Specified by:

getName in interface AgentChannelsFilter

Returns:

Name of this filter.

getAgents

public List<String> getAgents()

Description copied from interface: AgentChannelsFilter

Returns a list of agent names accepted by this filter.

Specified by:

getAgents in interface AgentChannelsFilter

Returns:

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

getOriginChannels

public List<String> getOriginChannels()

Description copied from interface: AgentChannelsFilter

Returns a list of original channel paths accepted by this filter.

Note that if this filter is used to configure AgentStatusAggregator or any clients that rely on it (like monitoring data views), the list returned by this method may contain templates and selectors. See AgentStatusAggregator.addListener(listener, agents, channels) for details.

Specified by:

getOriginChannels in interface AgentChannelsFilter

Returns:

Original channel paths accepted by this filter, or null if any original path for which AgentChannelsFilter.getDisplayPath(org.lsst.ccs.gconsole.agent.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 set, components downstream from this filter will display this fixed set of channels, whether or not the data is available, regardless of what paths are returned by AgentChannelsFilter.getDisplayPath(org.lsst.ccs.gconsole.agent.AgentChannel) applied to accepted original channels. Otherwise, any display channels for which the data is available will be displayed.

Specified by:

getDisplayChannels in interface AgentChannelsFilter

Returns:

Display paths produced by this filter, or null if the set is not fixed.

getOriginPath

public String getOriginPath(String displayPath)

Description copied from interface: AgentChannelsFilter

Returns the original path corresponding to the specified display channel.

Specified by:

getOriginPath in interface AgentChannelsFilter

Parameters:

displayPath - Display channel path.

Returns:

Original path, or null if the specified path does not correspond to any original channel.

getDisplayPath

public List<String> getDisplayPath(AgentChannel channel)

Description copied from interface: AgentChannelsFilter

Returns a list of display channels for the specified original channel. The default implementation forwards the call to AgentChannelsFilter.getDisplayPath(String) method. Subclasses may override it to take into account channel attributes and metadata.

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.

Specified by:

getDisplayPath in interface AgentChannelsFilter

Parameters:

channel - Original data channel.

Returns:

List of display channels.

getDisplayPath

public List<String> getDisplayPath(String originPath)

Description copied from interface: AgentChannelsFilter

Returns a list of display channels for the specified original path.

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.

Specified by:

getDisplayPath in interface AgentChannelsFilter

Parameters:

originPath - Original path.

Returns:

List of display channels.

getAttributes

public Map<String,Object> getAttributes(String path)

Description copied from interface: AgentChannelsFilter

Returns additional attributes associated with the specified path.

Specified by:

getAttributes in interface AgentChannelsFilter

Parameters:

path - Full or partial display path.

Returns:

Map of attribute names to their values.

getFields

public List<String> getFields(boolean compact)

Description copied from interface: AgentChannelsFilter

Returns a list of attributes to display for each channel.

Specified by:

getFields in interface AgentChannelsFilter

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.

addListener

public void addListener(AgentChannelsFilter.Listener listener)

Description copied from interface: AgentChannelsFilter

Registers a listener that will be notified of any changes in this filter.

Specified by:

addListener in interface AgentChannelsFilter

Parameters:

listener - Listener to be notified.

removeListener

public void removeListener(AgentChannelsFilter.Listener listener)

Description copied from interface: AgentChannelsFilter

Removes a listener.

Specified by:

removeListener in interface AgentChannelsFilter

Parameters:

listener - Listener to be removed.