rsb.filter

Class AbstractFilter

java.lang.Object

rsb.filter.AbstractFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

MethodFilter, OriginFilter, ScopeFilter, TypeFilter

public abstract class AbstractFilter
extends java.lang.Object
implements Filter

Author:

swrede

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	type
protected java.util.HashSet<EventId>	whitelist

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractFilter(java.lang.Class<? extends AbstractFilter> type)
protected	AbstractFilter(java.lang.String type)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	dispachToObserver(FilterObserver o, FilterAction a) Helper method for double dispatch of Filter registrations
boolean	mustSkip(EventId id) returns whether events with the specified ID should be skipped or not.
void	skip(EventId id) skip this filter for any event with the specified ID.
void	skipped(EventId id) remove ID from the list after the corresponding event has been skipped.
abstract Event	transform(Event e) This method does the actual filtering step.

Methods inherited from class java.lang.Object

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

Methods inherited from interface rsb.filter.Filter

equals

Field Detail

whitelist

protected java.util.HashSet<EventId> whitelist

type

protected java.lang.String type

Constructor Detail

AbstractFilter

protected AbstractFilter(java.lang.String type)

AbstractFilter

public AbstractFilter(java.lang.Class<? extends AbstractFilter> type)

Method Detail

transform

public abstract Event transform(Event e)

This method does the actual filtering step. If an event can be matched successfully against the condition of a specific filter, it is returned and processed by further filtering steps. If null is returned, the event is discarded.

Specified by:

transform in interface Filter

Parameters:

e - the event to be transformed

Returns:

the transformed event or null

skip

public void skip(EventId id)

skip this filter for any event with the specified ID. This will cause the MTF to successfully transform the event without applying any checks.

mustSkip

public boolean mustSkip(EventId id)

returns whether events with the specified ID should be skipped or not.

Parameters:

id -

Returns:

true, if the event with the specified ID should be skipped

skipped

public void skipped(EventId id)

remove ID from the list after the corresponding event has been skipped.

Parameters:

id -

dispachToObserver

public abstract void dispachToObserver(FilterObserver o,
                     FilterAction a)

Helper method for double dispatch of Filter registrations

Specified by:

dispachToObserver in interface Filter