org.lsst.ccs.gconsole.plugins.tracer

Class UserFilter

java.lang.Object

org.lsst.ccs.gconsole.plugins.tracer.UserFilter

All Implemented Interfaces:

InstanceDialog.Product, MessageFilter, MessageFilterFactory, Savable

public class UserFilter
extends Object
implements MessageFilter

User-defined message filter. Filters of this type are either read from a file or defined by the console user through the filter editor dialog.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
UserFilter(String name, TracerFilter[] filters, boolean[] or) Constructs a filter.

Method Summary

Modifier and Type	Method and Description
String	getPath() Returns the path of the filters created by this factory.
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

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

restore, save

Methods inherited from interface org.lsst.ccs.gconsole.base.InstanceDialog.Product

setCreator

Constructor Detail

UserFilter

public UserFilter(String name,
                  TracerFilter[] filters,
                  boolean[] or)

Constructs a filter. Objects supplied to this constructor will be owned by this filter.

Parameters:

name - Name of this filter.

filters - The sequence of filters.

or - OR flags for filters in the sequence.

Method Detail

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.

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.