org.lsst.ccs.gconsole.plugins.tracer

Interface MessageFilter

All Superinterfaces:

MessageFilterFactory

All Known Implementing Classes:

AbstractMessageFilter, AlertSelector, DataDictionary, LegacyFormatter, MessageFilterAdapter, StandardMessageFilter, StandardMessageFilter.All, StandardMessageFilter.Default, TracerFilter, UserFilter

public interface MessageFilter
extends MessageFilterFactory

Interface to be implemented by tracer filters. Applying this filter to a message may modify the message, in addition to accepting or rejecting it.

This interface extends MessageFilterFactory and provides a default implementation for its get(...) method. The method is implemented to return the filter itself. This allows registering instances of this class with the graphical console lookup to be picked up by the FilterRegistry. Note that this approach is only safe if the filter's test(...) method can be invoked concurrently by multiple threads on multiple messages. Default implementations provided for getParameters() and setParameters(...) methods are suitable for filters that have no parameters. Parameterized filters might use AbstractMessageFilter as a base class to simplify implementation.

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
default MessageFilter	get(String[] parameters) Returns a reference to this filter.
default String[]	getParameters()
default String	getPath() Returns the path of the filters created by this factory.
default void	setParameters(String[] parameters)
FilteredMessage	test(FilteredMessage filteredMessage) Applies this filter to the given message.

Methods inherited from interface org.lsst.ccs.gconsole.plugins.tracer.MessageFilterFactory

getDescription, getName

Method Detail

test

FilteredMessage test(FilteredMessage filteredMessage)

Applies this filter to the given message.

Parameters:

filteredMessage - The message to be filtered.

Returns:

The (possibly modified) message if it passes the filter; null otherwise.

get

default MessageFilter get(String[] parameters)

Returns a reference to this filter.

Specified by:

get in interface MessageFilterFactory

Parameters:

parameters - Parameters.

Returns:

Filter created by this factory.

getPath

default String getPath()

Description copied from interface: MessageFilterFactory

Returns the path of the filters created by this factory.

Specified by:

getPath in interface MessageFilterFactory

Returns:

Path.

getParameters

default String[] getParameters()

setParameters

default void setParameters(String[] parameters)