net.sourceforge.esw.service.log
Interface IFilterEngine

All Superinterfaces:
ISupportObject, java.rmi.Remote, java.io.Serializable
All Known Implementing Classes:
FilterEngine

public interface IFilterEngine
extends ISupportObject, java.rmi.Remote

Describes the basic concepts of a Filter Engine

There are two ways a generic filter engine could run. The first way is to act like a screen, and only let through the data objects that pass the filters that it is put through to the list of targets. This is most similar to optical Filters, which only allow light of certain frequencies to pass through. The second way is to Filter the potential targets based upon the data and only allow the data to pass through to the targets that pass the test. This is most similar to .

We use the second method.


Method Summary
 void addFilter(IFilter newFilter)
          adds this filter to the list of filters for this engine
 IFilter getFilter(java.lang.String aName)
          Returns the filter assigned this id
 INode getFilters()
          gets the list of filters that are run from this engine
 java.util.Iterator getLogs(INode checkDatum)
          Returns an Iterator of the logs that should have this datum logged to them
 IFilter removeFilter(java.lang.String aName)
          Removes the filter assigned this id
 IFilter replaceFilter(IFilter newFilter)
          Replaces the filter assigned this id
 
Methods inherited from interface net.sourceforge.esw.util.ISupportObject
addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, getID, getProperty, getPropertySize, propertyKeys, removeProperty, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setID, setProperty
 

Method Detail

getLogs

public java.util.Iterator getLogs(INode checkDatum)
Returns an Iterator of the logs that should have this datum logged to them

Returns:
Iterator the iterator of ILogs

addFilter

public void addFilter(IFilter newFilter)
adds this filter to the list of filters for this engine
Parameters:
newFilter - the new filter to be added

getFilter

public IFilter getFilter(java.lang.String aName)
Returns the filter assigned this id

Returns:
IFilter the filter or null;

removeFilter

public IFilter removeFilter(java.lang.String aName)
Removes the filter assigned this id

Returns:
IFilter the removed filter or null;

replaceFilter

public IFilter replaceFilter(IFilter newFilter)
Replaces the filter assigned this id

Returns:
IFilter the replaced filter or null;

getFilters

public INode getFilters()
gets the list of filters that are run from this engine
Returns:
Iterator the iterator of IFilters


Copyright 2002 Free Software Foundation. All Rights Reserved.