hep.aida
Interface IFilter

public interface IFilter

User's level interface of an IFilter.

Author:

The AIDA team (http://aida.freehep.org/)

Method Summary

boolean	accept() Check if the IFilter accepts or not the data in the current row of the ITuple it is associated to.
String	expression() Get the expression that defined the IFilter.
void	initialize(ITuple tuple) Initialize the IFilter and associate it to an ITuple.

Method Detail

initialize

public void initialize(ITuple tuple)
                throws IllegalArgumentException

Initialize the IFilter and associate it to an ITuple.

Parameters:

tuple - The ITuple to which the IFilter is sssociated.

Throws:

IllegalArgumentException - If the IFilter and the ITuple are not compatible.

accept

public boolean accept()
               throws RuntimeException

Check if the IFilter accepts or not the data in the current row of the ITuple it is associated to.

Returns:

true if the current data is accepted.

Throws:

RuntimeException - if the IFilter has not been initialized.

expression

public String expression()

Get the expression that defined the IFilter.

Returns:

The expression.