edu.uci.isr.yancees.filter
Interface FilterInterface

All Known Implementing Classes:
AbstractFilter, AbstractFilterManager.ResponseCollectorFilter, GenericFilter

public interface FilterInterface

Author:
rsilvafi To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Method Summary
 void addSuccessor(FilterInterface filter)
          Adds a sucessor to this filter
 java.lang.String getName()
           
 FilterInterface getSuccessor()
           
 void handleMessage(EventInterface evt)
          handles the current message and passes it forward to its sucessors if any.
 void handleMessage(EventInterface[] evtList)
          handles the current message and passes it forward to its sucessors if any.
 void removeSuccessor()
          Removes a sucessor.
 void setName(java.lang.String name)
          sets the name of this filter
 

Method Detail

getName

java.lang.String getName()
Returns:
the name of this filter

setName

void setName(java.lang.String name)
sets the name of this filter

Parameters:
name -

handleMessage

void handleMessage(EventInterface evt)
handles the current message and passes it forward to its sucessors if any.

Parameters:
evt -

handleMessage

void handleMessage(EventInterface[] evtList)
handles the current message and passes it forward to its sucessors if any.

Parameters:
evt -

addSuccessor

void addSuccessor(FilterInterface filter)
Adds a sucessor to this filter

Parameters:
filter - is the next filter to receive the message

removeSuccessor

void removeSuccessor()
Removes a sucessor. This is a management method. A filter can have many successors

Parameters:
filter - is the sucessor filter

getSuccessor

FilterInterface getSuccessor()
Returns:
the successor instance of this filter