org.lsst.ccs.gconsole.plugins.tracer

Class TracerFilter

java.lang.Object

org.lsst.ccs.gconsole.plugins.tracer.TracerFilter

All Implemented Interfaces:

MessageFilter, MessageFilterFactory

public class TracerFilter
extends Object
implements MessageFilter

Tracer-tailored implementation of MessageFilter.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TracerFilter.Method Enumeration of methods that determine how the filter definition string is interpreted to decide whether the target satisfies the filter.
static class	TracerFilter.Mode Enumeration of filter application modes.
static class	TracerFilter.Target Enumeration of targets to which the filter can be applied.

Field Summary

Fields

Modifier and Type	Field and Description
static String	T_P_DELIMETER Delimeter between target and pattern parts of the filter definition code string.

Constructor Summary

Constructors

Constructor and Description
TracerFilter(TracerFilter.Mode mode, boolean invert, boolean format, TracerFilter.Target target, TracerFilter.Method method, String code, Color color, FilteredMessage.Flag action, FilterRegistry registry)

Method Summary

Modifier and Type	Method and Description
FilteredMessage.Flag	getAction()
String	getCode()
Color	getColor()
TracerFilter.Method	getMethod()
TracerFilter.Mode	getMode()
String	getPath() Returns the path of the filters created by this factory.
TracerFilter.Target	getTarget()
boolean	isFormatting()
boolean	isInverted()
void	setName(String name)
FilteredMessage	test(FilteredMessage filteredMessage) Applies this filter to the given message.

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.plugins.tracer.MessageFilter

get, getParameters, setParameters

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

getDescription, getName

Field Detail

T_P_DELIMETER

public static final String T_P_DELIMETER

Delimeter between target and pattern parts of the filter definition code string.

See Also:

Constant Field Values

Constructor Detail

TracerFilter

public TracerFilter(TracerFilter.Mode mode,
                    boolean invert,
                    boolean format,
                    TracerFilter.Target target,
                    TracerFilter.Method method,
                    String code,
                    Color color,
                    FilteredMessage.Flag action,
                    FilterRegistry registry)

Method Detail

getMode

public TracerFilter.Mode getMode()

isInverted

public boolean isInverted()

isFormatting

public boolean isFormatting()

getTarget

public TracerFilter.Target getTarget()

getMethod

public TracerFilter.Method getMethod()

getCode

public String getCode()

getColor

public Color getColor()

getAction

public FilteredMessage.Flag getAction()

setName

public void setName(String name)

getPath

public String getPath()

Description copied from interface: MessageFilterFactory

Returns the path of the filters created by this factory.

Specified by:

getPath in interface MessageFilter

Specified by:

getPath in interface MessageFilterFactory

Returns:

Path.

test

public FilteredMessage test(FilteredMessage filteredMessage)

Description copied from interface: MessageFilter

Applies this filter to the given message.

Specified by:

test in interface MessageFilter

Parameters:

filteredMessage - The message to be filtered.

Returns:

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