edu.uci.isr.yancees.filter.generic
Class GenericFilter

java.lang.Object
  extended by edu.uci.isr.yancees.filter.AbstractFilter
      extended by edu.uci.isr.yancees.filter.generic.GenericFilter
All Implemented Interfaces:
FilterInterface

public class GenericFilter
extends AbstractFilter

Implements a generic filter that only forwards the message without changing it


Constructor Summary
GenericFilter()
           
 
Method Summary
protected  EventInterface[] doFilterEvent(EventInterface msg)
          This method should be implemented by the subclasses of the AbstractFilter in order to process the messages being passed through this filter.
protected  EventInterface[] doFilterEventList(EventInterface[] evtList)
          This method should be implemented by the subclasses of the AbstractFilter in order to process the messages being passed through this filter.
 
Methods inherited from class edu.uci.isr.yancees.filter.AbstractFilter
addSuccessor, getName, getSuccessor, handleMessage, handleMessage, removeSuccessor, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GenericFilter

public GenericFilter()
Parameters:
name -
Method Detail

doFilterEvent

protected EventInterface[] doFilterEvent(EventInterface msg)
Description copied from class: AbstractFilter
This method should be implemented by the subclasses of the AbstractFilter in order to process the messages being passed through this filter. A filter uses this method to receive the message and process it. The filter must then select which events to let go to the next filter or subscriber. These events are returned in the method.

Specified by:
doFilterEvent in class AbstractFilter
Parameters:
msg - is the event to be filtered
Returns:
is the list of events resulted from the filtering

doFilterEventList

protected EventInterface[] doFilterEventList(EventInterface[] evtList)
Description copied from class: AbstractFilter
This method should be implemented by the subclasses of the AbstractFilter in order to process the messages being passed through this filter. A filter uses this method to receive the message and process it. The filter must then select which events to let go to the next filter or subscriber. These events are returned in the method.

Specified by:
doFilterEventList in class AbstractFilter
Parameters:
evtList - is a list of events to be filtered as a "burst"
Returns:
is the list of events resulted from the filtering