edu.uci.isr.yancees.filter
Interface FilterManagerInterface

All Known Implementing Classes:
AbstractFilterManager, InputFilterManager, OutputFilterManager

public interface FilterManagerInterface

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

Method Summary
 void addFilter(FilterInterface filter)
          Add a filter to the end of a list and register it under a name
 EventInterface[] filterEvent(EventInterface evt)
          Handles the event passing it through the chain of responsibility formed by the filters managed by this object.
 EventInterface[] filterEventList(EventInterface[] evt)
          Handles the event list passing them through the chain of responsibility formed by the filters managed by this object.
 FilterInterface getFilterAt(int i)
           
 FilterInterface getFilterByName(java.lang.String name)
           
 FilterInterface[] getFilters()
           
 void insertFilterAt(FilterInterface filter, int i)
          Insters a filter in the provided position in the filters stream
 void removeFilterAt(int i)
          Remove the element at provided position from filters streams
 

Method Detail

getFilterByName

FilterInterface getFilterByName(java.lang.String name)
Parameters:
name - is the unique name of the filter
Returns:
the filter registered under the unique name

getFilters

FilterInterface[] getFilters()
Returns:
the list of all the filters, in the order they are installed

addFilter

void addFilter(FilterInterface filter)
Add a filter to the end of a list and register it under a name

Parameters:
filter - is the filter to be inserted after all current filters
name - is the name of the filter

getFilterAt

FilterInterface getFilterAt(int i)
Parameters:
i - is the position of the filter to be returned
Returns:
the filter at the provided position

insertFilterAt

void insertFilterAt(FilterInterface filter,
                    int i)
Insters a filter in the provided position in the filters stream

Parameters:
filter - is the filter to be inserted
i - is the position to insert the filter

removeFilterAt

void removeFilterAt(int i)
Remove the element at provided position from filters streams

Parameters:
i - is the position of the filter to be removed

filterEvent

EventInterface[] filterEvent(EventInterface evt)
Handles the event passing it through the chain of responsibility formed by the filters managed by this object.

Parameters:
msg - is the message to be routed through the filters
Returns:
the event generated throught the filtering process

filterEventList

EventInterface[] filterEventList(EventInterface[] evt)
Handles the event list passing them through the chain of responsibility formed by the filters managed by this object.

Parameters:
msg - is the message to be routed through the filters
Returns:
the event generated throught the filtering process