rsb.filter

Class OriginFilter

java.lang.Object

rsb.filter.AbstractFilter

rsb.filter.OriginFilter

All Implemented Interfaces:

Filter

public class OriginFilter
extends AbstractFilter

Events matched by this filter have to originate from a particular participant.

Author:

swrede, jmoringe

Field Summary

Fields inherited from class rsb.filter.AbstractFilter

type, whitelist

Constructor Summary

Constructors

Constructor and Description
OriginFilter(ParticipantId origin)
OriginFilter(ParticipantId origin, boolean invert)

Method Summary

Methods

Modifier and Type	Method and Description
void	dispachToObserver(FilterObserver o, FilterAction a) Helper method for double dispatch of Filter registrations
boolean	equals(java.lang.Object that)
ParticipantId	getOrigin()
boolean	isInverted()
void	skip(EventId id) skip this filter for any event with the specified ID.
Event	transform(Event e) This method does the actual filtering step.

Methods inherited from class rsb.filter.AbstractFilter

mustSkip, skipped

Methods inherited from class java.lang.Object

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

Constructor Detail

OriginFilter

public OriginFilter(ParticipantId origin,
            boolean invert)

OriginFilter

public OriginFilter(ParticipantId origin)

Method Detail

getOrigin

public ParticipantId getOrigin()

isInverted

public boolean isInverted()

transform

public Event transform(Event e)

Description copied from class: AbstractFilter

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

Specified by:

transform in class AbstractFilter

Parameters:

e - the event to be transformed

Returns:

the transformed event or null

dispachToObserver

public void dispachToObserver(FilterObserver o,
                     FilterAction a)

Description copied from class: AbstractFilter

Helper method for double dispatch of Filter registrations

Specified by:

dispachToObserver in interface Filter

Specified by:

dispachToObserver in class AbstractFilter

skip

public void skip(EventId id)

Description copied from class: AbstractFilter

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

Overrides:

skip in class AbstractFilter

equals

public boolean equals(java.lang.Object that)

Specified by:

equals in interface Filter

Overrides:

equals in class java.lang.Object