org.lsst.ccs.gconsole.plugins.trending

Class RenamingFilter

java.lang.Object

org.lsst.ccs.gconsole.plugins.trending.RenamingFilter

All Implemented Interfaces:

TrendingFilter

public class RenamingFilter
extends Object
implements TrendingFilter

Filter that modifies display paths and titles of trending channels.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
RenamingFilter(Collection<String[]> entries) Constructs the filter.
RenamingFilter(Map<TrendingChannel,String> nameMap) Constructs the filter.

Method Summary

Modifier and Type	Method and Description
TrendingSource	filter(TrendingSource source) Applies the filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenamingFilter

public RenamingFilter(Map<TrendingChannel,String> nameMap)

Constructs the filter.

Parameters:

nameMap - Map of channels available from the source produced by this filter to original paths.

RenamingFilter

public RenamingFilter(Collection<String[]> entries)

Constructs the filter. Each element of the collection passed to this method should be a 1, 2, or 3 element array. The first element is the original (unfiltered) path associated with a trending channel. The second element is the new path (if omitted, the channel retains its original path). The third element is the title (if omitted, the path will be used as the title).

Parameters:

entries - Mapping of original paths to filtered path and titles.

Method Detail

filter

public TrendingSource filter(TrendingSource source)

Applies the filter.

Specified by:

filter in interface TrendingFilter

Parameters:

source - The original source.

Returns:

The filtered source.