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.

Author:

onoprien

Nested Class Summary

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

AgentChannelsFilter.Event, AgentChannelsFilter.Listener

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

descriptor

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

ALL, CATEGORY

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>	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 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 org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

getDescriptor, notifyListeners

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.PersistableAgentChannelsFilter

getUnfiltered

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

getDisplayPath, getDisplayPath, getDisplayPath, getOriginPaths, isSelector, matchTemplate

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

edit, getCategory, 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 default implementation returns null.

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.

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 available, regardless of what paths are returned by AgentChannelsFilter.getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel) applied to accepted original channels. Otherwise, any display channels for which the data is available will be displayed.

The default implementation returns null.

Returns:

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

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.

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.

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.

getAttributes

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

Description copied from interface: AgentChannelsFilter

Returns additional attributes associated with the specified path.

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.

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

Overrides:

addListener in class AbstractChannelsFilter

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

Overrides:

removeListener in class AbstractChannelsFilter

Parameters:

listener - Listener to be removed.